avutil/frame: Document avcodec_get_frame_class() and the option naming system

Missing docs found by: nevcairiel Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
9 years ago · 003a9e4854
parent 77ba4a7843
commit 003a9e4854
1 changed files with 4 additions and 0 deletions
--- 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