diff avcodec.h @ 5953:402833508709 libavcodec

Clarify documentation for avcodec_encode_audio. patch by Stefano Sabatini, stefano.sabatini-lala poste it

--- a/avcodec.h	Tue Nov 27 22:57:26 2007 +0000
+++ b/avcodec.h	Wed Nov 28 12:41:35 2007 +0000
@@ -2674,8 +2674,10 @@
  * @param[out] buf the output buffer
  * @param[in] buf_size the output buffer size
  * @param[in] samples the input buffer containing the samples
+ * The number of samples read from this buffer is frame_size*channels,
+ * both of which are defined in \p avctx.
  * @return On error a negative value is returned, on succes zero or the number
- * of bytes used from the input buffer.
+ * of bytes used to encode the data read from the input buffer.
  */
 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
                          const short *samples);