avcodec: doxy: Clarify how to use buf[] when implementing get_buffer2()
authorDerek Buitenhuis <derek.buitenhuis@gmail.com>
Mon, 29 Apr 2013 02:15:34 +0000 (22:15 -0400)
committerDerek Buitenhuis <derek.buitenhuis@gmail.com>
Tue, 30 Apr 2013 17:33:43 +0000 (13:33 -0400)
Signed-off-by: Derek Buitenhuis <derek.buitenhuis@gmail.com>
libavcodec/avcodec.h

index c9526c7..2085eb6 100644 (file)
@@ -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
     /**
      * 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:
      *
      * The following fields will be set in the frame before this callback is
      * called: