Future doxy for a few fields of AVSubtitleRect.
authorMichael Niedermayer <michaelni@gmx.at>
Sat, 3 Jan 2009 17:58:25 +0000 (17:58 +0000)
committerMichael Niedermayer <michaelni@gmx.at>
Sat, 3 Jan 2009 17:58:25 +0000 (17:58 +0000)
Originally committed as revision 16413 to svn://svn.ffmpeg.org/ffmpeg/trunk

libavcodec/avcodec.h

index 8a82281..3269561 100644 (file)
@@ -2394,11 +2394,11 @@ enum AVSubtitleType {
 };
 
 typedef struct AVSubtitleRect {
-    uint16_t x;
-    uint16_t y;
-    uint16_t w;
-    uint16_t h;
-    uint16_t nb_colors;
+    uint16_t x;         ///< top left corner  of pict, undefined when pict is not set
+    uint16_t y;         ///< top left corner  of pict, undefined when pict is not set
+    uint16_t w;         ///< width            of pict, undefined when pict is not set
+    uint16_t h;         ///< height           of pict, undefined when pict is not set
+    uint16_t nb_colors; ///< number of colors in pict, undefined when pict is not set
     int linesize;
     uint32_t *rgba_palette;
     uint8_t *bitmap;