gst/gstelement.c: use full enum names and preprend a '%' in docs strings to make recent gtk-doc turn that into a link

Original commit message from CVS:
* gst/gstelement.c:
use full enum names and preprend a '%' in docs strings to make recent
gtk-doc turn that into a link
This commit is contained in:
Stefan Kost 2006-05-06 21:45:27 +00:00
parent e5bd4d9b7d
commit 57cc3ab3aa
2 changed files with 13 additions and 7 deletions

View file

@ -1,3 +1,9 @@
2006-05-07 Stefan Kost <ensonic@users.sf.net>
* gst/gstelement.c:
use full enum names and preprend a '%' in docs strings to make recent
gtk-doc turn that into a link
2006-05-05 Tim-Philipp Müller <tim at centricular dot net>
* docs/manual/basics-bins.xml:

View file

@ -1745,7 +1745,7 @@ interrupted:
/**
* gst_element_get_state:
* @element: a #GstElement to get the state of.
* @state: a pointer to #GstState to hold the state. Can be NULL.
* @state: a pointer to #GstState to hold the state. Can be %NULL.
* @pending: a pointer to #GstState to hold the pending state.
* Can be %NULL.
* @timeout: a #GstClockTime to specify the timeout for an async
@ -1859,9 +1859,9 @@ nothing_aborted:
* pending state if any. This function is used
* by elements that do asynchronous state changes.
* The core will normally call this method automatically when an
* element returned SUCCESS from the state change function.
* Elements that return ASYNC from the change_state function should
* eventually call this method from the streaming thread to signal
* element returned %GST_STATE_CHANGE_SUCCESS from the state change function.
* Elements that return %GST_STATE_CHANGE_ASYNC from the change_state function
* should eventually call this method from the streaming thread to signal
* successfull state change completion.
*
* If after calling this method the element still has not reached
@ -1964,11 +1964,11 @@ complete:
*
* Brings the element to the lost state. The current state of the
* element is copied to the pending state so that any call to
* gst_element_get_state() will return ASYNC.
* gst_element_get_state() will return %GST_STATE_CHANGE_ASYNC.
*
* This is mostly used for elements that lost their preroll buffer
* in the PAUSED state after a flush, they become PAUSED again
* if a new preroll buffer is queued.
* in the %GST_STATE_PAUSED state after a flush, they become %GST_STATE_PAUSED
* again if a new preroll buffer is queued.
* This function can only be called when the element is currently
* not in error or an async state change.
*