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

Michael Niedermayer michaelni at gmx.at
Wed Nov 21 23:55:22 CET 2012


On Wed, Nov 21, 2012 at 09:13:09PM +0100, Stefano Sabatini wrote:
> On date Wednesday 2012-11-21 19:54:15 +1100, Peter Ross encoded:
> > Signed-off-by: Peter Ross <pross at xvid.org>
> > ---
> > This one should apply cleanly now. Well spotted Paul.
> > 
> >  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 ee0348f..036614d 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).
> > - * @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 85f052e..4b916cc 100644
> > --- a/libavformat/avformat.h
> > +++ b/libavformat/avformat.h
> > @@ -1803,9 +1803,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
> 
> LGTM, thanks.

applied

thanks

[...]
-- 
Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

Concerning the gods, I have no means of knowing whether they exist or not
or of what sort they may be, because of the obscurity of the subject, and
the brevity of human life -- Protagoras
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 198 bytes
Desc: Digital signature
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20121121/a4940d59/attachment.asc>


More information about the ffmpeg-devel mailing list