gst/gstpad.h: Add doc

Original commit message from CVS:
* gst/gstpad.h:
Add doc

diff --git a/ChangeLog b/ChangeLog
index ecaa42b..0c4c3fa 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2008-08-14  Thijs Vermeir  <thijsvermeir@gmail.com>
+
+       * gst/gstpad.h:
+       Add doc
+
 2008-08-14  Wim Taymans  <wim.taymans@collabora.co.uk>
 
        * libs/gst/base/gstbasetransform.c:

diff --git a/gst/gstpad.h b/gst/gstpad.h
index 63b5bb4..9879bee 100644 (file)
--- a/gst/gstpad.h
+++ b/gst/gstpad.h
@@ -428,7 +428,8 @@ typedef void                        (*GstPadFixateCapsFunction)     (GstPad *pad, GstCaps *caps);
  * @size.
  *
  * When this function returns anything else than #GST_FLOW_OK, the buffer allocation
- * failed and @buf does not contain valid data.
+ * failed and @buf does not contain valid data. If the function returns #GST_FLOW_OK and
+ * the @buf is NULL, a #GstBuffer will be created with @caps, @offset and @size.
  *
  * By default this function returns a new buffer of @size and with @caps containing
  * purely malloced data. The buffer should be freed with gst_buffer_unref()