OSDN Git Service

Try to improve reordered_opaque doxy.
authorMichael Niedermayer <michaelni@gmx.at>
Sat, 4 Dec 2010 05:44:29 +0000 (05:44 +0000)
committerMichael Niedermayer <michaelni@gmx.at>
Sat, 4 Dec 2010 05:44:29 +0000 (05:44 +0000)
Originally committed as revision 25876 to svn://svn.ffmpeg.org/ffmpeg/trunk

libavcodec/avcodec.h

index 4a0d2fb..1ec4842 100644 (file)
@@ -992,8 +992,12 @@ typedef struct AVPanScan{
     int8_t *ref_index[2];\
 \
     /**\
-     * reordered opaque 64bit number (generally a PTS) from AVCodecContext.reordered_opaque\
-     * output in AVFrame.reordered_opaque\
+     * reordered opaque 64bit (generally a integer or double preccission float \
+     * PTS but can be anything). \
+     * The user sets AVCodecContext.reordered_opaque to represent the input at\
+     * that time ,\
+     * the decoder reorderes values as needed and sets AVFrame.reordered_opaque\
+     * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque \
      * - encoding: unused\
      * - decoding: Read by user.\
      */\