From b40fa2b8c3485a8374186ca047622ab518e09485 Mon Sep 17 00:00:00 2001 From: Sebastian Rasmussen Date: Sat, 30 Nov 2013 14:52:40 +0100 Subject: [PATCH] docs: cosmetic changes in references/decriptions * fix typo GstBufferFlag -> GstBufferFlags * fix typo GstFeatures -> GstCapsFeatures * fix typo GstAllocatorParams -> GstAllocationParams * fix typo GstContrlSources -> GstControlSource * do not refer to gstcheck as an object * make references gtk_init() and tcase_set_timeout() not be references * gst_element_get_pad() renamed gst_element_get_static_pad() * gst_clock_id_wait_async_full() renamed gst_clock_id_wait_async() * _drop_element() is really gst_queue_array_drop_element() * gst_pad_accept_caps() was removed, do not refer to it * separate GST_META_TAG_MEMORY_STR declaration from description * do not describe removed gst_collect_pads_collect() * correctly link to GstElementClass' virtual set_context() Fixes https://bugzilla.gnome.org/show_bug.cgi?id=719614 --- gst/gst.c | 2 +- gst/gstbuffer.c | 2 +- gst/gstbuffer.h | 8 ++++---- gst/gstcaps.c | 2 +- gst/gstcontext.c | 2 +- gst/gstmeta.h | 1 + gst/gstpad.c | 2 +- gst/gstutils.c | 2 +- libs/gst/base/gstbasesrc.c | 2 +- libs/gst/base/gstbasetransform.c | 2 +- libs/gst/base/gstcollectpads.c | 5 ----- libs/gst/base/gstqueuearray.c | 2 +- libs/gst/check/gsttestclock.c | 6 +++--- libs/gst/controller/gsttimedvaluecontrolsource.c | 2 +- 14 files changed, 18 insertions(+), 22 deletions(-) diff --git a/gst/gst.c b/gst/gst.c index 47f1f2a94f..2ff9eee8fc 100644 --- a/gst/gst.c +++ b/gst/gst.c @@ -377,7 +377,7 @@ gst_init_check (int *argc, char **argv[], GError ** err) * * * WARNING: This function does not work in the same way as corresponding - * functions in other glib-style libraries, such as gtk_init(). In + * functions in other glib-style libraries, such as gtk_init\(\). In * particular, unknown command line options cause this function to * abort program execution. */ diff --git a/gst/gstbuffer.c b/gst/gstbuffer.c index 8c46fa438a..5808420890 100644 --- a/gst/gstbuffer.c +++ b/gst/gstbuffer.c @@ -91,7 +91,7 @@ * * Several flags of the buffer can be set and unset with the * GST_BUFFER_FLAG_SET() and GST_BUFFER_FLAG_UNSET() macros. Use - * GST_BUFFER_FLAG_IS_SET() to test if a certain #GstBufferFlag is set. + * GST_BUFFER_FLAG_IS_SET() to test if a certain #GstBufferFlags flag is set. * * Buffers can be efficiently merged into a larger buffer with * gst_buffer_append(). Copying of memory will only be done when absolutely diff --git a/gst/gstbuffer.h b/gst/gstbuffer.h index c241792d4b..74f698ff67 100644 --- a/gst/gstbuffer.h +++ b/gst/gstbuffer.h @@ -44,13 +44,13 @@ typedef struct _GstBufferPool GstBufferPool; * GST_BUFFER_FLAGS: * @buf: a #GstBuffer. * - * A flags word containing #GstBufferFlag flags set on this buffer. + * A flags word containing #GstBufferFlags flags set on this buffer. */ #define GST_BUFFER_FLAGS(buf) GST_MINI_OBJECT_FLAGS(buf) /** * GST_BUFFER_FLAG_IS_SET: * @buf: a #GstBuffer. - * @flag: the #GstBufferFlag to check. + * @flag: the #GstBufferFlags flag to check. * * Gives the status of a specific flag on a buffer. */ @@ -58,7 +58,7 @@ typedef struct _GstBufferPool GstBufferPool; /** * GST_BUFFER_FLAG_SET: * @buf: a #GstBuffer. - * @flag: the #GstBufferFlag to set. + * @flag: the #GstBufferFlags flag to set. * * Sets a buffer flag on a buffer. */ @@ -66,7 +66,7 @@ typedef struct _GstBufferPool GstBufferPool; /** * GST_BUFFER_FLAG_UNSET: * @buf: a #GstBuffer. - * @flag: the #GstBufferFlag to clear. + * @flag: the #GstBufferFlags flag to clear. * * Clears a buffer flag. */ diff --git a/gst/gstcaps.c b/gst/gstcaps.c index fbe9c1813d..83f1aa7ecf 100644 --- a/gst/gstcaps.c +++ b/gst/gstcaps.c @@ -866,7 +866,7 @@ gst_caps_get_features (const GstCaps * caps, guint index) * gst_caps_set_features: * @caps: a #GstCaps * @index: the index of the structure - * @features: (allow-none) (transfer full): the #GstFeatures to set + * @features: (allow-none) (transfer full): the #GstCapsFeatures to set * * Sets the #GstCapsFeatures @features for the structure at @index. * diff --git a/gst/gstcontext.c b/gst/gstcontext.c index 75a1c3f6dd..9498968859 100644 --- a/gst/gstcontext.c +++ b/gst/gstcontext.c @@ -32,7 +32,7 @@ * * Applications can set a context on a complete pipeline by using * gst_element_set_context(), which will then be propagated to all - * child elements. Elements can handle these in GstElement::set_context() + * child elements. Elements can handle these in #GstElementClass.set_context() * and merge them with the context information they already have. * * When an element needs a context it will do the following actions in this diff --git a/gst/gstmeta.h b/gst/gstmeta.h index d294126fe1..0020a09dd1 100644 --- a/gst/gstmeta.h +++ b/gst/gstmeta.h @@ -83,6 +83,7 @@ typedef enum { /** * GST_META_TAG_MEMORY_STR: + * * This metadata stays relevant as long as memory layout is unchanged. * * Since: 1.2 diff --git a/gst/gstpad.c b/gst/gstpad.c index 8d9f926e31..8a1cb4856a 100644 --- a/gst/gstpad.c +++ b/gst/gstpad.c @@ -47,7 +47,7 @@ * * gst_pad_get_parent() will retrieve the #GstElement that owns the pad. * - * After two pads are retrieved from an element with gst_element_get_pad(), + * After two pads are retrieved from an element by gst_element_get_static_pad(), * the pads can be linked with gst_pad_link(). (For quick links, * you can also use gst_element_link(), which will make the obvious * link for you if it's straightforward.). Pads can be unlinked again with diff --git a/gst/gstutils.c b/gst/gstutils.c index 4e5f8b8bbd..9408a7e367 100644 --- a/gst/gstutils.c +++ b/gst/gstutils.c @@ -2436,7 +2436,7 @@ query_accept_caps_func (GstPad * pad, QueryAcceptCapsData * data) * @pad: a #GstPad to proxy. * @query: an ACCEPT_CAPS #GstQuery. * - * Calls gst_pad_accept_caps() for all internally linked pads of @pad and + * Checks if all internally linked pads of @pad accepts the caps in @query and * returns the intersection of the results. * * This function is useful as a default accept caps query function for an element diff --git a/libs/gst/base/gstbasesrc.c b/libs/gst/base/gstbasesrc.c index 10b5a35b6f..d5bad3ddf6 100644 --- a/libs/gst/base/gstbasesrc.c +++ b/libs/gst/base/gstbasesrc.c @@ -3740,7 +3740,7 @@ gst_base_src_get_buffer_pool (GstBaseSrc * src) * @allocator: (out) (allow-none) (transfer full): the #GstAllocator * used * @params: (out) (allow-none) (transfer full): the - * #GstAllocatorParams of @allocator + * #GstAllocationParams of @allocator * * Lets #GstBaseSrc sub-classes to know the memory @allocator * used by the base class and its @params. diff --git a/libs/gst/base/gstbasetransform.c b/libs/gst/base/gstbasetransform.c index 8e28154f49..be75cff4c8 100644 --- a/libs/gst/base/gstbasetransform.c +++ b/libs/gst/base/gstbasetransform.c @@ -2722,7 +2722,7 @@ gst_base_transform_get_buffer_pool (GstBaseTransform * trans) * @allocator: (out) (allow-none) (transfer full): the #GstAllocator * used * @params: (out) (allow-none) (transfer full): the - * #GstAllocatorParams of @allocator + * #GstAllocationParams of @allocator * * Lets #GstBaseTransform sub-classes to know the memory @allocator * used by the base class and its @params. diff --git a/libs/gst/base/gstcollectpads.c b/libs/gst/base/gstcollectpads.c index a322df2071..c82b0d46ff 100644 --- a/libs/gst/base/gstcollectpads.c +++ b/libs/gst/base/gstcollectpads.c @@ -65,11 +65,6 @@ * no pad is blocked and the element can finish streaming. * * - * gst_collect_pads_collect() and gst_collect_pads_collect_range() can be used by - * elements that start a #GstTask to drive the collect_pads. This feature is however - * not yet implemented. - * - * * gst_collect_pads_set_waiting() sets a pad to waiting or non-waiting mode. * CollectPads element is not waiting for data to be collected on non-waiting pads. * Thus these pads may but need not have data when the callback is called. diff --git a/libs/gst/base/gstqueuearray.c b/libs/gst/base/gstqueuearray.c index 4de9ed8076..72f863ea83 100644 --- a/libs/gst/base/gstqueuearray.c +++ b/libs/gst/base/gstqueuearray.c @@ -297,7 +297,7 @@ gst_queue_array_drop_element (GstQueueArray * array, guint idx) * Note that the index is not 0-based, but an internal index number with a * random offset. The index can be used in connection with * gst_queue_array_drop_element(). FIXME: return index 0-based and make - * _drop_element() take a 0-based index. + * gst_queue_array_drop_element() take a 0-based index. * * Returns: Index of the found element or -1 if nothing was found. * diff --git a/libs/gst/check/gsttestclock.c b/libs/gst/check/gsttestclock.c index f9737a6aa6..7ddc8e6ec4 100644 --- a/libs/gst/check/gsttestclock.c +++ b/libs/gst/check/gsttestclock.c @@ -57,7 +57,7 @@ * #GstClock allows for setting up single shot or periodic clock notifications * as well as waiting for these notifications synchronously (using * gst_clock_id_wait()) or asynchronously (using gst_clock_id_wait_async() or - * gst_clock_id_wait_async_full()). This is used by many GStreamer elements, + * gst_clock_id_wait_async()). This is used by many GStreamer elements, * among them #GstBaseSrc and #GstBaseSink. * * #GstTestClock keeps track of these clock notifications. By calling @@ -79,9 +79,9 @@ * gst_test_clock_wait_for_pending_id_count() then these functions may block * for a long time. If they block forever then the expected clock notifications * were never requested from #GstTestClock, and so the assumptions in the code - * of the unit test are wrong. The unit test case runner in #GstCheck is + * of the unit test are wrong. The unit test case runner in gstcheck is * expected to catch these cases either by the default test case timeout or the - * one set for the unit test by calling tcase_set_timeout(). + * one set for the unit test by calling tcase_set_timeout\(\). * * The sample code below assumes that the element under test will delay a * buffer pushed on the source pad by some latency until it arrives on the sink diff --git a/libs/gst/controller/gsttimedvaluecontrolsource.c b/libs/gst/controller/gsttimedvaluecontrolsource.c index 19cb92737d..0d0b8be20a 100644 --- a/libs/gst/controller/gsttimedvaluecontrolsource.c +++ b/libs/gst/controller/gsttimedvaluecontrolsource.c @@ -26,7 +26,7 @@ * SECTION:gsttimedvaluecontrolsource * @short_description: timed value control source base class * - * Base class for #GstContrlSources that use time-stamped values. + * Base class for #GstControlSource that use time-stamped values. * * When overriding bind, chain up first to give this bind implementation a * chance to setup things.