From ee6955e9f9b0eef0861833fa49e3ab2c9d29bc1f Mon Sep 17 00:00:00 2001
From: Benjamin Otte <otte@gnome.org>
Date: Thu, 22 Oct 2009 09:26:37 +0100
Subject: Document all missing structures

---
 gst-libs/gst/cairo/gstcairoformat.c | 22 ++++++++++++++++++++++
 gst-libs/gst/cairo/gstcairopad.c    | 15 ++++++++++++++-
 2 files changed, 36 insertions(+), 1 deletion(-)

diff --git a/gst-libs/gst/cairo/gstcairoformat.c b/gst-libs/gst/cairo/gstcairoformat.c
index 1803ac0..1727143 100644
--- a/gst-libs/gst/cairo/gstcairoformat.c
+++ b/gst-libs/gst/cairo/gstcairoformat.c
@@ -45,6 +45,28 @@ struct
   0,}
 };
 
+/**
+ * GstCairoFormat:
+ *
+ * Opaque structure representing a fixed #GstCaps that gst-plugins-cairo can
+ * accept. It is use instead of caps because it is more convenient and 
+ * provides useful utility functions.
+ */
+
+/**
+ * GstCairoFormatOption:
+ * @GST_CAIRO_FORMAT_FORMAT: operate on colorspaces
+ * @GST_CAIRO_FORMAT_WIDTH: operate on width
+ * @GST_CAIRO_FORMAT_HEIGHT: operate on height
+ * @GST_CAIRO_FORMAT_SIZE: operate on width and height - this option is
+ *                         equivalent to listing width and height separately
+ * @GST_CAIRO_FORMAT_FRAMERATE: operate on framerate
+ * @GST_CAIRO_FORMAT_PAR: operate on pixel aspect ratio
+ *
+ * Some functions operating on #GstCairoFormat or #GstCaps allow specifying
+ * on which parts to operate. This enumeration is used to specify that.
+ */
+
 static void
 get_format_for_caps (GstCairoFormat * format, GstCaps * caps)
 {
diff --git a/gst-libs/gst/cairo/gstcairopad.c b/gst-libs/gst/cairo/gstcairopad.c
index 96e74c8..a6c7574 100644
--- a/gst-libs/gst/cairo/gstcairopad.c
+++ b/gst-libs/gst/cairo/gstcairopad.c
@@ -42,6 +42,19 @@
  *          gst-plugins-cairo supports.
  **/
 
+/**
+ * GstCairoRestrictCapsFunction:
+ * @caps: caps to restrict
+ * @data: data passed to gst_cairo_pad_alloc_buffer_full()
+ *
+ * Function used when fixating caps in gst_cairo_pad_alloc_buffer_full().
+ * The function is supposed to return a possibly reduced #GstCaps that
+ * should be used for caps negotiation. If the restricted caps would be
+ * empty, this function should return %NULL.
+ *
+ * Returns: %NULL or a subset of the given caps.
+ */
+
 /**
  * gst_cairo_pad_alloc_buffer:
  * @pad: a source pad
@@ -63,7 +76,7 @@ gst_cairo_pad_alloc_buffer (GstPad * pad, GstBuffer ** buffer)
 /**
  * gst_cairo_pad_alloc_buffer_full:
  * @pad: a source pad
- * @restrict_func: function that restricts allowed caps.
+ * @restrict_func: function that restricts allowed caps or %NULL
  * @restrict_data: data to pass to @restrict_func
  * @set_caps: %TRUE to set caps on @pad if the pad doesn't have caps yet.
  * @buffer: location to store newly allocated buffer
-- 
cgit v1.2.3