doc changes

Original commit message from CVS:
doc changes
This commit is contained in:
Thomas Vander Stichele 2002-04-23 10:32:16 +00:00
parent 28b5fbad9d
commit 6a9527a4d7

View file

@ -1245,11 +1245,11 @@ gst_element_error (GstElement *element, const gchar *error, ...)
/** /**
* gst_element_get_state: * gst_element_get_state:
* @element: element to get state of * @element: a #GstElement to get state of
* *
* Gets the state of the element. * Gets the state of the element.
* *
* Returns: The element state * Returns: The #GstElementState of the element
*/ */
GstElementState GstElementState
gst_element_get_state (GstElement *element) gst_element_get_state (GstElement *element)
@ -1261,9 +1261,9 @@ gst_element_get_state (GstElement *element)
/** /**
* gst_element_wait_state_change: * gst_element_wait_state_change:
* @element: element wait for * @element: a #GstElement to wait for
* *
* Wait and block until the element changed its state. * Waits and blocks until the element changed its state.
*/ */
void void
gst_element_wait_state_change (GstElement *element) gst_element_wait_state_change (GstElement *element)
@ -1275,13 +1275,15 @@ gst_element_wait_state_change (GstElement *element)
/** /**
* gst_element_set_state: * gst_element_set_state:
* @element: element to change state of * @element: a #GstElement to change state of
* @state: new element state * @state: the element's new #GstElementState
* *
* Sets the state of the element. This function will only set * Sets the state of the element. This function will try to set the
* the element's pending state. * requested state by going through all the intermediary states and calling
* the class's state change function for each.
* *
* Returns: whether or not the state was successfully set. * Returns: whether or not the state was successfully set
* (using #GstElementStateReturn).
*/ */
gint gint
gst_element_set_state (GstElement *element, GstElementState state) gst_element_set_state (GstElement *element, GstElementState state)