lavf: properly document the distinction between flags and ctx_flags
authorAnton Khirnov <anton@khirnov.net>
Thu, 1 May 2014 08:03:54 +0000 (10:03 +0200)
committerAnton Khirnov <anton@khirnov.net>
Wed, 14 May 2014 05:47:56 +0000 (07:47 +0200)
libavformat/avformat.h

index 02ee6ba..1ce3eba 100644 (file)
@@ -927,7 +927,11 @@ typedef struct AVFormatContext {
     AVIOContext *pb;
 
     /* stream info */
-    int ctx_flags; /**< Format-specific flags, see AVFMTCTX_xx */
+    /**
+     * Flags signalling stream properties. A combination of AVFMTCTX_*.
+     * Set by libavformat.
+     */
+    int ctx_flags;
 
     /**
      * Number of elements in AVFormatContext.streams.
@@ -985,6 +989,10 @@ typedef struct AVFormatContext {
     unsigned int packet_size;
     int max_delay;
 
+    /**
+     * Flags modifying the (de)muxer behaviour. A combination of AVFMT_FLAG_*.
+     * Set by the user before avformat_open_input() / avformat_write_header().
+     */
     int flags;
 #define AVFMT_FLAG_GENPTS       0x0001 ///< Generate missing pts even if it requires parsing future frames.
 #define AVFMT_FLAG_IGNIDX       0x0002 ///< Ignore index.