gst/: Another 1% more coverage.

Original commit message from CVS:
* gst/gstbuffer.h:
* gst/gstpad.c:
* gst/gstparse.c:
Another 1% more coverage.

diff --git a/ChangeLog b/ChangeLog
index a406588..b872b50 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,12 @@
 2005-10-20  Wim Taymans  <wim@fluendo.com>
 
+       * gst/gstbuffer.h:
+       * gst/gstpad.c:
+       * gst/gstparse.c:
+       Another 1% more coverage.
+
+2005-10-20  Wim Taymans  <wim@fluendo.com>
+
        * docs/gst/gstreamer-sections.txt:
        * gst/gstelement.c: (gst_element_get_state_func),
        (gst_element_abort_state), (gst_element_commit_state),

diff --git a/gst/gstbuffer.h b/gst/gstbuffer.h
index a9da5a8..a9ef9f2 100644 (file)
--- a/gst/gstbuffer.h
+++ b/gst/gstbuffer.h
@@ -317,8 +317,32 @@ GstBuffer* gst_buffer_create_sub           (GstBuffer *parent, guint offset, guint size);
 gboolean       gst_buffer_is_span_fast         (GstBuffer *buf1, GstBuffer *buf2);
 GstBuffer*     gst_buffer_span                 (GstBuffer *buf1, guint32 offset, GstBuffer *buf2, guint32 len);
 
+/**
+ * gst_value_set_buffer:
+ * @v: a #GstValue to receive the data
+ * @b: a #GstBuffer to assign to the GstValue
+ *
+ * Sets @b as the value of @v, correclty incrementing the refcount of
+ * the buffer.
+ */
 #define                gst_value_set_buffer(v,b)       gst_value_set_mini_object(v, GST_MINI_OBJECT(b))
+/**
+ * gst_value_take_buffer:
+ * @v: a #GstValue to receive the data
+ * @b: a #GstBuffer to assign to the GstValue
+ *
+ * Sets @b as the value of @v, this function lets the GstValue
+ * take ownership of the buffer.
+ */
 #define                gst_value_take_buffer(v,b)      gst_value_take_mini_object(v, GST_MINI_OBJECT(b))
+/**
+ * gst_value_get_buffer:
+ * @v: a #GstValue to qeury
+ *
+ * Receives a #GstBuffer as the value of @v. This function does not
+ * increase the refcount of the returned buffer so the buffer remains
+ * valid as long as you own a refcount to the GstValue.
+ */
 #define                gst_value_get_buffer(v)         GST_BUFFER (gst_value_get_mini_object(v))
 
 /* --- protected --- */

diff --git a/gst/gstpad.c b/gst/gstpad.c
index d613b7e..996b964 100644 (file)
--- a/gst/gstpad.c
+++ b/gst/gstpad.c
@@ -2777,6 +2777,19 @@ no_func:
   }
 }
 
+/**
+ * gst_pad_query_default:
+ * @pad: a #GstPad to call the default query handler on.
+ * @query: the #GstQuery to handle.
+ *
+ * Invokes the default query handler for the given pad. 
+ * The query is sent to all pads internally linked to @pad. Note that 
+ * if there are many possible sink pads that are internally linked to 
+ * @pad, only one will be sent the query.
+ * Multi-sinkpad elements should implement custom query handlers.
+ *
+ * Returns: TRUE if the query was performed succesfully.
+ */
 gboolean
 gst_pad_query_default (GstPad * pad, GstQuery * query)
 {

diff --git a/gst/gstparse.c b/gst/gstparse.c
index 05f56a2..5532c7a 100644 (file)
--- a/gst/gstparse.c
+++ b/gst/gstparse.c
@@ -38,6 +38,13 @@
 
 extern GstElement *_gst_parse_launch (const gchar *, GError **);
 
+/**
+ * gst_parse_error_quark:
+ *
+ * Get the error quark used by the parsing subsystem.
+ *
+ * Returns: the quark of the parse errors.
+ */
 GQuark
 gst_parse_error_quark (void)
 {