Extend doxy for the src parameter of av_fifo_generic_write().
authorStefano Sabatini <stefano.sabatini-lala@poste.it>
Wed, 24 Feb 2010 23:52:52 +0000 (23:52 +0000)
committerStefano Sabatini <stefano.sabatini-lala@poste.it>
Wed, 24 Feb 2010 23:52:52 +0000 (23:52 +0000)
@patchby Tomas Härdin |tomas dot hardin at codemill dot se|

Originally committed as revision 22043 to svn://svn.ffmpeg.org/ffmpeg/trunk

libavutil/fifo.h

index a904dfd02eec40b832b06dffc1c7923f2dddeaa2..68ed064c1d5b98197d590cae5554159b3321f80d 100644 (file)
@@ -81,7 +81,8 @@ int av_fifo_generic_read(AVFifoBuffer *f, void *dest, int buf_size, void (*func)
 /**
  * Feeds data from a user-supplied callback to an AVFifoBuffer.
  * @param *f AVFifoBuffer to write to
 /**
  * Feeds data from a user-supplied callback to an AVFifoBuffer.
  * @param *f AVFifoBuffer to write to
- * @param *src data source
+ * @param *src data source; non-const since it may be used as a
+ * modifiable context by the function defined in func
  * @param size number of bytes to write
  * @param *func generic write function; the first parameter is src,
  * the second is dest_buf, the third is dest_buf_size.
  * @param size number of bytes to write
  * @param *func generic write function; the first parameter is src,
  * the second is dest_buf, the third is dest_buf_size.