avutil/frame: Add some very basic documentation for AVFrameSideData
authorMichael Niedermayer <michaelni@gmx.at>
Mon, 23 Mar 2015 17:34:30 +0000 (18:34 +0100)
committerMichael Niedermayer <michaelni@gmx.at>
Mon, 23 Mar 2015 17:46:26 +0000 (18:46 +0100)
Reviewed-by: "Ronald S. Bultje" <rsbultje@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
libavutil/frame.h

index 6b9ac6a..2fab79e 100644 (file)
@@ -124,6 +124,13 @@ enum AVActiveFormatDescription {
     AV_AFD_SP_4_3       = 15,
 };
 
+
+/**
+ * Structure to hold side data for an AVFrame.
+ *
+ * sizeof(AVFrameSideData) is not a part of the public ABI, so new fields may be added
+ * to the end with a minor bump.
+ */
 typedef struct AVFrameSideData {
     enum AVFrameSideDataType type;
     uint8_t *data;