avcodec: Document where the AVOption names can be found for the fields of AVCodecContext
authorMichael Niedermayer <michael@niedermayer.cc>
Sat, 28 May 2016 14:57:14 +0000 (16:57 +0200)
committerMichael Niedermayer <michael@niedermayer.cc>
Wed, 1 Jun 2016 16:12:39 +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>
libavcodec/avcodec.h

index 339a1b2..5fcecda 100644 (file)
@@ -1638,6 +1638,10 @@ enum AVFieldOrder {
  * version bump.
  * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
  * applications.
+ * The name string for AVOptions options matches the associated command line
+ * parameter name and can be found in libavcodec/options_table.h
+ * The AVOption/command line parameter names differ in some cases from the C
+ * structure field names for historic reasons or brevity.
  * sizeof(AVCodecContext) must not be used outside libav*.
  */
 typedef struct AVCodecContext {