doc fixes

Original commit message from CVS:
* docs/gst/gstreamer-sections.txt:
* gst/gstelement.c:
* gst/gstminiobject.c:
doc fixes

diff --git a/ChangeLog b/ChangeLog
index a93ab81..207dc76 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2005-11-03  Stefan Kost  <ensonic@users.sf.net>
+
+       * docs/gst/gstreamer-sections.txt:
+       * gst/gstelement.c:
+       * gst/gstminiobject.c:
+       doc fixes
+
 2005-11-03  Andy Wingo  <wingo@pobox.com>
 
        * check/states/sinks.c (test_livesrc_sink): Add checks that the

diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt
index af29c69..5048c40 100644 (file)
--- a/docs/gst/gstreamer-sections.txt
+++ b/docs/gst/gstreamer-sections.txt
@@ -1970,6 +1970,7 @@ gst_uri_protocol_is_valid
 gst_uri_is_valid
 gst_uri_get_protocol
 gst_uri_get_location
+gst_uri_get_uri_type
 gst_uri_construct
 gst_element_make_from_uri
 gst_uri_handler_get_uri_type

diff --git a/gst/gstelement.c b/gst/gstelement.c
index 12dc6ee..492d80c 100644 (file)
--- a/gst/gstelement.c
+++ b/gst/gstelement.c
@@ -1496,9 +1496,9 @@ void gst_element_message_full
  * This way you can leave currently unused elements inside bins. Just lock their
  * state before changing the state from #GST_STATE_NULL.
  *
- * Returns: TRUE, if the element's state is locked.
- *
  * MT safe.
+ *
+ * Returns: TRUE, if the element's state is locked.
  */
 gboolean
 gst_element_is_locked_state (GstElement * element)
@@ -1522,10 +1522,10 @@ gst_element_is_locked_state (GstElement * element)
  * Locks the state of an element, so state changes of the parent don't affect
  * this element anymore.
  *
- * Returns: TRUE if the state was changed, FALSE if bad params were given or
- * the element was already in the correct state.
- *
  * MT safe.
+ *
+ * Returns: TRUE if the state was changed, FALSE if bad parameterss were given
+ * or the elements state-locking needed no change.
  */
 gboolean
 gst_element_set_locked_state (GstElement * element, gboolean locked_state)

diff --git a/gst/gstminiobject.c b/gst/gstminiobject.c
index 70c2584..838cf6a 100644 (file)
--- a/gst/gstminiobject.c
+++ b/gst/gstminiobject.c
@@ -540,6 +540,18 @@ gst_param_spec_mini_object_get_type (void)
   return type;
 }
 
+/**
+ * gst_param_spec_mini_object:
+ * @name: the canonical name of the property
+ * @nick: the nickname of the property
+ * @blurb: a short description of the property
+ * @object_type: the #GstMiniObjectType for the property
+ * @flags: a combination of #GParamFlags
+ *
+ * Creates a new #GParamSpec instance that hold #GstMiniObject references.
+ *
+ * Returns: a newly allocated #GParamSpec instance
+ */
 GParamSpec *
 gst_param_spec_mini_object (const char *name, const char *nick,
     const char *blurb, GType object_type, GParamFlags flags)