diff options
| author | Michael Niedermayer <michael@niedermayer.cc> | 2016-05-28 16:57:14 +0200 |
|---|---|---|
| committer | Michael Niedermayer <michael@niedermayer.cc> | 2016-06-01 18:12:39 +0200 |
| commit | b8426b865edd2f82a26ab7e990dd98a174b9da32 (patch) | |
| tree | 9bf3084b07662737c1ad636d52ebbed280a43fc1 /libavcodec | |
| parent | 003a9e4854d6c88c703c6429b547544166d96eab (diff) | |
avcodec: Document where the AVOption names can be found for the fields of AVCodecContext
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>
Diffstat (limited to 'libavcodec')
| -rw-r--r-- | libavcodec/avcodec.h | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h index 339a1b2184..5fcecda626 100644 --- a/libavcodec/avcodec.h +++ b/libavcodec/avcodec.h @@ -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 { |