[FFmpeg-devel] [PATCH 1/2] use correct doxygen parameter direction syntax

Paul B Mahol onemda at gmail.com
Tue Nov 20 09:56:33 CET 2012


On 11/19/12, Peter Ross <pross at xvid.org> wrote:
> Signed-off-by: Peter Ross <pross at xvid.org>
> ---
>  libavcodec/g729dec.c   |   10 +++++-----
>  libavformat/avformat.h |    4 ++--
>  2 files changed, 7 insertions(+), 7 deletions(-)
>
> diff --git a/libavcodec/g729dec.c b/libavcodec/g729dec.c
> index 7c12b0e..09a84bf 100644
> --- a/libavcodec/g729dec.c
> +++ b/libavcodec/g729dec.c
> @@ -189,8 +189,8 @@ static inline int get_parity(uint8_t value)
>
>  /*
>   * Decodes LSF (Line Spectral Frequencies) from L0-L3 (3.2.4).

But this is not doxygen comment.
> - * @param lsfq [out] (2.13) quantized LSF coefficients
> - * @param past_quantizer_outputs [in/out] (2.13) quantizer outputs from
> previous frames
> + * @param[out] lsfq (2.13) quantized LSF coefficients
> + * @param[in,out] past_quantizer_outputs (2.13) quantizer outputs from
> previous frames
>   * @param ma_predictor switched MA predictor of LSP quantizer
>   * @param vq_1st first stage vector of quantizer
>   * @param vq_2nd_low second stage lower vector of LSP quantizer
> @@ -232,8 +232,8 @@ static void lsf_decode(int16_t* lsfq, int16_t*
> past_quantizer_outputs[MA_NP + 1]
>
>  /**
>   * Restores past LSP quantizer output using LSF from previous frame
> - * @param lsfq [in/out] (2.13) quantized LSF coefficients
> - * @param past_quantizer_outputs [in/out] (2.13) quantizer outputs from
> previous frames
> + * @param[in,out] lsfq (2.13) quantized LSF coefficients
> + * @param[in,out] past_quantizer_outputs (2.13) quantizer outputs from
> previous frames
>   * @param ma_predictor_prev MA predictor from previous frame
>   * @param lsfq_prev (2.13) quantized LSF coefficients from previous frame
>   */
> @@ -256,7 +256,7 @@ static void lsf_restore_from_previous(int16_t* lsfq,
>
>  /**
>   * Constructs new excitation signal and applies phase filter to it
> - * @param out[out] constructed speech signal
> + * @param[out] out constructed speech signal
>   * @param in original excitation signal
>   * @param fc_cur (2.13) original fixed-codebook vector
>   * @param gain_code (14.1) gain code
> diff --git a/libavformat/avformat.h b/libavformat/avformat.h
> index 8f18604..a3c068e 100644
> --- a/libavformat/avformat.h
> +++ b/libavformat/avformat.h
> @@ -1796,9 +1796,9 @@ enum AVCodecID av_guess_codec(AVOutputFormat *fmt,
> const char *short_name,
>   * work in real time.
>   * @param s          media file handle
>   * @param stream     stream in the media file
> - * @param dts[out]   DTS of the last packet output for the stream, in
> stream
> + * @param[out] dts   DTS of the last packet output for the stream, in
> stream
>   *                   time_base units
> - * @param wall[out]  absolute time when that packet whas output,
> + * @param[out] wall  absolute time when that packet whas output,
>   *                   in microsecond
>   * @return  0 if OK, AVERROR(ENOSYS) if the format does not support it
>   * Note: some formats or devices may not allow to measure dts and wall
> --
> 1.7.10.4

probably ok


More information about the ffmpeg-devel mailing list