avutil/frame: Document avcodec_get_frame_class() and the option naming system
authorMichael Niedermayer <michael@niedermayer.cc>
Sat, 28 May 2016 14:57:13 +0000 (16:57 +0200)
committerMichael Niedermayer <michael@niedermayer.cc>
Wed, 1 Jun 2016 16:12:34 +0000 (18:12 +0200)
Missing docs found by: nevcairiel

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

index 2d6299b..b30aa47 100644 (file)
@@ -176,6 +176,10 @@ typedef struct AVFrameSideData {
  * Similarly fields that are marked as to be only accessed by
  * av_opt_ptr() can be reordered. This allows 2 forks to add fields
  * without breaking compatibility with each other.
+ *
+ * Fields can be accessed through AVOptions, the name string used, matches the
+ * C structure field name for fields accessable through AVOptions. The AVClass
+ * for AVFrame can be obtained from avcodec_get_frame_class()
  */
 typedef struct AVFrame {
 #define AV_NUM_DATA_POINTERS 8