[FFmpeg-devel] [PATCH] Clarify documentation for avcodec_encode_audio

[Stefano Sabatini]

On date Monday 2007-11-19 11:19:11 +0100, Stefano Sabatini encoded:
> On date Monday 2007-11-12 09:49:24 +0100, Stefano Sabatini encoded:
> > On date Sunday 2007-11-04 23:07:41 +0100, Stefano Sabatini encoded:
> > > Hi all,
> > > 
> > > suggested log: $subject.
> > > 
> > > Relevant thread (ffmpeg-user):
> > > http://thread.gmane.org/20070920133523.GC28112 at santefisi.caos.org
> > 
> > Ping.
> 
> New ping and patch diffed against the latest SVN.
> 
> Best regards.
> -- 
> Stefano Sabatini
> Linux user number 337176 (see http://counter.li.org)

> Index: libavcodec/avcodec.h
> ===================================================================
> --- libavcodec/avcodec.h	(revision 11059)
> +++ libavcodec/avcodec.h	(working copy)
> @@ -2672,9 +2672,11 @@
>   * @param avctx the codec context
>   * @param[out] buf the output buffer
>   * @param[in] buf_size the output buffer size
> - * @param[in] samples the input buffer containing the samples
> - * @return On error a negative value is returned, on succes zero or the number
> - * of bytes used from the input buffer.
> + * @param[in] samples the input buffer containing the samples. The
> + * number of samples read from this buffer is defined in
> + * avctx->frame_size.
> + * @return On error a negative value is returned, on success zero or
> + * the number of bytes used to encode the data read from \p samples.
>   */
>  int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
>                           const short *samples);

Ping??

Please let me know if you don't care at all about documentation
patches, I have so many better ways to waste my time.

Regards.
-- 
Stefano Sabatini
Linux user number 337176 (see http://counter.li.org)