[FFmpeg-devel] [PATCH 1/3] avutil/frame: Document avcodec_get_frame_class() and the option naming system

[Michael Niedermayer]

Missing docs found by: nevcairiel

Signed-off-by: Michael Niedermayer <michael at niedermayer.cc>
---
 libavutil/frame.h |    4 ++++
 1 file changed, 4 insertions(+)

diff --git a/libavutil/frame.h b/libavutil/frame.h
index 2d6299b..b30aa47 100644
--- a/libavutil/frame.h
+++ b/libavutil/frame.h
@@ -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
-- 
1.7.9.5