mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-02-01 03:52:25 +00:00
Code Issues 1 Projects Releases Wiki Activity

harness: fix up docs to reference functions properly

Browse source 
https://bugzilla.gnome.org/show_bug.cgi?id=761901
This commit is contained in:
Havard Graff 2015-09-29 12:12:24 +02:00 committed by Tim-Philipp Müller
parent b92d639fbf
commit ed583832a1
1 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
libs/gst/check/gstharness.c
View file

@ -709,7 +709,7 @@ gst_harness_new_full (GstElement * element,
* srcpad that is then linked to the harness sinkpad. %NULL does not attach a * srcpad that is then linked to the harness sinkpad. %NULL does not attach a
* srcpad * srcpad
* *
* Creates a new harness. Works in the same way as gst_harness_new_full, only * Creates a new harness. Works in the same way as gst_harness_new_full(), only
* that generic padtemplates are used for the harness src and sinkpads, which * that generic padtemplates are used for the harness src and sinkpads, which
* will be sufficient in most usecases. * will be sufficient in most usecases.
* *
@ -738,7 +738,7 @@ gst_harness_new_with_element (GstElement * element,
* srcpad that is then linked to the harness sinkpad. %NULL does not attach a * srcpad that is then linked to the harness sinkpad. %NULL does not attach a
* srcpad * srcpad
* *
* Creates a new harness. Works in the same way as gst_harness_new_with_element, * Creates a new harness. Works like gst_harness_new_with_element(),
* except you specify the factoryname of the #GstElement * except you specify the factoryname of the #GstElement
* *
* MT safe. * MT safe.
@ -770,7 +770,7 @@ gst_harness_new_with_padnames (const gchar * element_name,
* @hsink: (allow-none): a #GstStaticPadTemplate describing the harness sinkpad. * @hsink: (allow-none): a #GstStaticPadTemplate describing the harness sinkpad.
* %NULL will not create a harness sinkpad. * %NULL will not create a harness sinkpad.
* *
* Creates a new harness, like gst_harness_new_full, except it * Creates a new harness, like gst_harness_new_full(), except it
* assumes the #GstElement sinkpad is named "sink" and srcpad is named "src" * assumes the #GstElement sinkpad is named "sink" and srcpad is named "src"
* *
* MT safe. * MT safe.
@ -797,7 +797,7 @@ gst_harness_new_with_templates (const gchar * element_name,
* gst_harness_new: (skip) * gst_harness_new: (skip)
* @element_name: a #gchar describing the #GstElement name * @element_name: a #gchar describing the #GstElement name
* *
* Creates a new harness. Works like gst_harness_new_with_padnames, except it * Creates a new harness. Works like gst_harness_new_with_padnames(), except it
* assumes the #GstElement sinkpad is named "sink" and srcpad is named "src" * assumes the #GstElement sinkpad is named "sink" and srcpad is named "src"
* *
* MT safe. * MT safe.
@ -1338,7 +1338,7 @@ gst_harness_crank_single_clock_wait (GstHarness * h)
* @h: a #GstHarness * @h: a #GstHarness
* @waits: a #guint describing the number of #GstClockIDs to crank * @waits: a #guint describing the number of #GstClockIDs to crank
* *
* Similar to gst_harness_crank_single_clock_wait, this is the function to use * Similar to gst_harness_crank_single_clock_wait(), this is the function to use
* if your harnessed element(s) are using more then one gst_clock_id_wait. * if your harnessed element(s) are using more then one gst_clock_id_wait.
* Failing to do so can (and will) make it racy which #GstClockID you actually * Failing to do so can (and will) make it racy which #GstClockID you actually
* are releasing, where as this function will process all the waits at the * are releasing, where as this function will process all the waits at the
@ -1381,7 +1381,7 @@ gst_harness_crank_multiple_clock_waits (GstHarness * h, guint waits)
* Non-src #GstElements (like sinks and filters) are automatically set to * Non-src #GstElements (like sinks and filters) are automatically set to
* playing by the #GstHarness, but src #GstElements are not to avoid them * playing by the #GstHarness, but src #GstElements are not to avoid them
* starting to produce buffers. * starting to produce buffers.
* Hence, for src #GstElement you will need to call gst_harness_play explicitly. * Hence, for src #GstElement you must call gst_harness_play() explicitly.
* *
* MT safe. * MT safe.
* *
@ -1404,9 +1404,9 @@ gst_harness_play (GstHarness * h)
* @h: a #GstHarness * @h: a #GstHarness
* *
* Setting this will make the harness block in the chain-function, and * Setting this will make the harness block in the chain-function, and
* then release when gst_harness_pull or gst_harness_try_pull is called. * then release when gst_harness_pull() or gst_harness_try_pull() is called.
* Can be useful when wanting to control a src-element that is not implementing * Can be useful when wanting to control a src-element that is not implementing
* gst_clock_id_wait so it can't be controlled by the #GstTestClock, since * gst_clock_id_wait() so it can't be controlled by the #GstTestClock, since
* it otherwise would produce buffers as fast as possible. * it otherwise would produce buffers as fast as possible.
* *
* MT safe. * MT safe.
@ -1431,7 +1431,7 @@ gst_harness_set_blocking_push_mode (GstHarness * h)
* the sink-harness. It will also forward the %GST_QUERY_ALLOCATION. * the sink-harness. It will also forward the %GST_QUERY_ALLOCATION.
* *
* If forwarding is disabled, the user will have to either manually push * If forwarding is disabled, the user will have to either manually push
* these events from the src-harness using gst_harness_src_push_event, or * these events from the src-harness using gst_harness_src_push_event(), or
* create and push them manually. While this will allow full control and * create and push them manually. While this will allow full control and
* inspection of these events, for the most cases having forwarding enabled * inspection of these events, for the most cases having forwarding enabled
* will be sufficient when writing a test where the src-harness' main function * will be sufficient when writing a test where the src-harness' main function