On Wed, Nov 02, 2011 at 11:24:25AM -0400, Justin Ruggles wrote:
> Add some parameters to existing function documentation.
> Remove some unneeded documentation.
> Convert some static function documentation to non-doxygen style.
>
> --- a/libavcodec/ac3enc.c
> +++ b/libavcodec/ac3enc.c
> @@ -176,6 +176,8 @@ static const int8_t ac3_coupling_start_tab[6][3][19] = {
> /**
> * Adjust the frame size to make the average bit rate match the target bit
> rate.
> * This is only needed for 11025, 22050, and 44100 sample rates or any
> E-AC-3.
> + *
> + * @param s AC3 encoder private context
I think we write "AC-3" everywhere else; more instances below.
> @@ -987,6 +1007,12 @@ static void count_mantissa_bits_init(uint16_t
> mant_cnt[AC3_MAX_BLOCKS][16])
> /**
> * Update mantissa bit counts for all blocks in 1 channel in a given
> bandwidth
> * range.
> + *
> + * @param s AC3 encoder private context
> + * @param ch channel index
> + * @param mant_cnt[in,out] running counts for each bap value for each block
This is invalid syntax, the [in,out] needs to come after @param like this:
@param[in,out] mant_cnt running counts for each bap value for each block
> @@ -1154,6 +1193,14 @@ static inline int asym_quant(int c, int e, int qbits)
>
> /**
> * Quantize a set of mantissas for a single channel in a single block.
> + *
> + * @param s Mantissa count context
> + * @param fixed_coef unquantized fixed-point coefficients
> + * @param exp exponents
> + * @param bap bit allocation pointer indices
> + * @param qmant[out] quantized coefficients
ditto
Diego
_______________________________________________
libav-devel mailing list
[email protected]
https://lists.libav.org/mailman/listinfo/libav-devel
