doc fixes

Original commit message from CVS:
* docs/gst/gstreamer-sections.txt:
* gst/gstelement.c:
* gst/gstminiobject.c:
doc fixes
This commit is contained in:
Stefan Kost 2005-11-03 19:38:48 +00:00
parent e2200c1f82
commit 87df15ff58
4 changed files with 25 additions and 5 deletions

View file

@ -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

View file

@ -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

View file

@ -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)

View file

@ -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)