From d1efdd54f2bf034960df5e09165c6b4599e44022 Mon Sep 17 00:00:00 2001 From: Michael Niedermayer Date: Sat, 28 May 2016 16:57:15 +0200 Subject: [PATCH] avformat: Document where the AVOption names can be found for the fields of AVFormatContext 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 --- libavformat/avformat.h | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/libavformat/avformat.h b/libavformat/avformat.h index 3eeeb9a139..f66c39b1c1 100644 --- a/libavformat/avformat.h +++ b/libavformat/avformat.h @@ -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 { /**