[FFmpeg-cvslog] avcodec: doxy: Clarify how to use buf[] when implementing get_buffer2()

[Derek Buitenhuis]

ffmpeg | branch: master | Derek Buitenhuis <derek.buitenhuis at gmail.com> | Sun Apr 28 22:15:34 2013 -0400| [00b8e650e83b2a8848e07a56cf9a925b694403bc] | committer: Derek Buitenhuis

avcodec: doxy: Clarify how to use buf[] when implementing get_buffer2()

Signed-off-by: Derek Buitenhuis <derek.buitenhuis at gmail.com>

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=00b8e650e83b2a8848e07a56cf9a925b694403bc
---

 libavcodec/avcodec.h |    6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index c9526c7..2085eb6 100644
--- a/libavcodec/avcodec.h
+++ b/libavcodec/avcodec.h
@@ -1898,8 +1898,10 @@ typedef struct AVCodecContext {
     /**
      * This callback is called at the beginning of each frame to get data
      * buffer(s) for it. There may be one contiguous buffer for all the data or
-     * there may be a buffer per each data plane or anything in between. Each
-     * buffer must be reference-counted using the AVBuffer API.
+     * there may be a buffer per each data plane or anything in between. What
+     * this means is, you may set however many entries in buf[] you feel necessary.
+     * Each buffer must be reference-counted using the AVBuffer API (see description
+     * of buf[] below).
      *
      * The following fields will be set in the frame before this callback is
      * called: