avformat: Document where the AVOption names can be found for the fields of AVFormatCo...
authorMichael Niedermayer <michael@niedermayer.cc>
Sat, 28 May 2016 14:57:15 +0000 (16:57 +0200)
committerMichael Niedermayer <michael@niedermayer.cc>
Wed, 1 Jun 2016 16:12:45 +0000 (18:12 +0200)
Missing docs found by: nevcairiel

RFC: should we add support so that the C field names always work as av option names/keys ?

Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
libavformat/avformat.h

index 3eeeb9a..f66c39b 100644 (file)
@@ -1305,6 +1305,12 @@ typedef struct AVFormatInternal AVFormatInternal;
  * version bump.
  * sizeof(AVFormatContext) must not be used outside libav*, use
  * avformat_alloc_context() to create an AVFormatContext.
+ *
+ * Fields can be accessed through AVOptions (av_opt*),
+ * the name string used matches the associated command line parameter name and
+ * can be found in libavformat/options_table.h.
+ * The AVOption/command line parameter names differ in some cases from the C
+ * structure field names for historic reasons or brevity.
  */
 typedef struct AVFormatContext {
     /**