docs: add gtk-doc chunks with Since: tags for new GST_VIDEO_CAPS_GRAY* API
authorTim-Philipp Müller <tim.muller@collabora.co.uk>
Wed, 7 Apr 2010 19:21:14 +0000 (20:21 +0100)
committerTim-Philipp Müller <tim.muller@collabora.co.uk>
Wed, 7 Apr 2010 19:21:14 +0000 (20:21 +0100)
gst-libs/gst/video/video.h

index e92a0f1..809a0a7 100644 (file)
@@ -240,6 +240,13 @@ typedef enum {
             "height = " GST_VIDEO_SIZE_RANGE ", "                       \
             "framerate = " GST_VIDEO_FPS_RANGE
 
+/**
+ * GST_VIDEO_CAPS_YUV:
+ * @fourcc: YUV fourcc format that describes the pixel layout, as string
+ *     (e.g. "I420", "YV12", "YUY2", "AYUV", etc.)
+ *
+ * Generic caps string for YUV video, for use in pad templates.
+ */
 #define GST_VIDEO_CAPS_YUV(fourcc)                                      \
         "video/x-raw-yuv, "                                             \
         "format = (fourcc) " fourcc ", "                                \
@@ -247,6 +254,13 @@ typedef enum {
         "height = " GST_VIDEO_SIZE_RANGE ", "                           \
         "framerate = " GST_VIDEO_FPS_RANGE
 
+/**
+ * GST_VIDEO_CAPS_GRAY8:
+ *
+ * Generic caps string for 8-bit grayscale video, for use in pad templates.
+ *
+ * Since: 0.10.29
+ */
 #define GST_VIDEO_CAPS_GRAY8                                            \
         "video/x-raw-gray, "                                            \
         "bpp = (int) 8, "                                               \
@@ -255,6 +269,15 @@ typedef enum {
         "height = " GST_VIDEO_SIZE_RANGE ", "                           \
         "framerate = " GST_VIDEO_FPS_RANGE
 
+/**
+ * GST_VIDEO_CAPS_GRAY16:
+ * @endianness: endianness as string, ie. either "1234", "4321", "BIG_ENDIAN"
+ *     or "LITTLE_ENDIAN"
+ *
+ * Generic caps string for 16-bit grayscale video, for use in pad templates.
+ *
+ * Since: 0.10.29
+ */
 #define GST_VIDEO_CAPS_GRAY16(endianness)                               \
         "video/x-raw-gray, "                                            \
         "bpp = (int) 16, "                                              \