Commit 23da3639 authored by Stefan Kost's avatar Stefan Kost

docs: fix xrefs in docs

Fix typos in xrefs, links to non existing functions and rework plural forms.
parent c95b233c
......@@ -447,7 +447,7 @@ GstBuffer* gst_buffer_make_metadata_writable (GstBuffer *buf);
* @nbuf: pointer to a #GstBuffer that will replace the buffer pointed to by
* @obuf.
*
* Modifies a pointer to a #Gstbuffer to point to a different #GstBuffer. The
* Modifies a pointer to a #GstBuffer to point to a different #GstBuffer. The
* modification is done atomically (so this is useful for ensuring thread safety
* in some cases), and the reference counts are updated appropriately (the old
* buffer is unreffed, the new is reffed).
......@@ -473,7 +473,7 @@ GstBuffer* gst_buffer_span (GstBuffer *buf1, guint32 offset
/**
* gst_value_set_buffer:
* @v: a #GstValue to receive the data
* @v: a #GValue to receive the data
* @b: a #GstBuffer to assign to the GstValue
*
* Sets @b as the value of @v. Caller retains reference to buffer.
......@@ -481,7 +481,7 @@ GstBuffer* gst_buffer_span (GstBuffer *buf1, guint32 offset
#define gst_value_set_buffer(v,b) gst_value_set_mini_object(v, GST_MINI_OBJECT_CAST(b))
/**
* gst_value_take_buffer:
* @v: a #GstValue to receive the data
* @v: a #GValue to receive the data
* @b: a #GstBuffer to assign to the GstValue
*
* Sets @b as the value of @v. Caller gives away reference to buffer.
......@@ -489,7 +489,7 @@ GstBuffer* gst_buffer_span (GstBuffer *buf1, guint32 offset
#define gst_value_take_buffer(v,b) gst_value_take_mini_object(v, GST_MINI_OBJECT_CAST(b))
/**
* gst_value_get_buffer:
* @v: a #GstValue to qeury
* @v: a #GValue to query
*
* Receives a #GstBuffer as the value of @v. Does not return a reference to
* the buffer, so the pointer is only valid for as long as the caller owns
......
......@@ -24,7 +24,7 @@
* @short_description: Asynchronous message bus subsystem
* @see_also: #GstMessage, #GstElement
*
* The #GstBus is an object responsible for delivering #GstMessages in
* The #GstBus is an object responsible for delivering #GstMessage packets in
* a first-in first-out way from the streaming threads to the application.
*
* Since the application typically only wants to deal with delivery of these
......@@ -44,8 +44,8 @@
*
* The bus can be polled with the gst_bus_poll() method. This methods blocks
* up to the specified timeout value until one of the specified messages types
* is posted on the bus. The application can then _pop() the messages from the
* bus to handle them.
* is posted on the bus. The application can then gst_bus_pop() the messages
* from the bus to handle them.
* Alternatively the application can register an asynchronous bus function
* using gst_bus_add_watch_full() or gst_bus_add_watch(). This function will
* install a #GSource in the default glib main loop and will deliver messages
......
......@@ -377,8 +377,8 @@ gst_caps_make_writable (GstCaps * caps)
* gst_caps_make_writable(), it is guaranteed that the caps object will not
* change. This means its structures won't change, etc. To use a #GstCaps
* object, you must always have a refcount on it -- either the one made
* implicitly by gst_caps_new(), or via taking one explicitly with this
* function.
* implicitly by e.g. gst_caps_new_simple(), or via taking one explicitly with
* this function.
*
* Returns: the same #GstCaps object.
*/
......@@ -814,7 +814,7 @@ gst_caps_get_size (const GstCaps * caps)
* are writable, either because you have just copied them or made
* them writable with gst_caps_make_writable(), you may modify the
* structure returned in the usual way, e.g. with functions like
* gst_structure_set_simple().
* gst_structure_set().
*
* You do not need to free or unref the structure returned, it
* belongs to the #GstCaps.
......
......@@ -87,7 +87,7 @@ void _gst_debug_bin_to_dot_file_with_ts (GstBin *bin, GstDebugGraphDetails detai
* one or more other #GstDebugGraphDetails flags.
* @file_name: output base filename (e.g. "myplayer")
*
* This works like _gst_debug_bin_to_dot_file(), but adds the current timestamp
* This works like GST_DEBUG_BIN_TO_DOT_FILE(), but adds the current timestamp
* to the filename, so that it can be used to take multiple snapshots.
*
* Since: 0.10.15
......
......@@ -31,7 +31,7 @@
* if (node) {
* result = GST_OBJECT (node->data);
* gst_object_ref (result);
* gst_list_free (node);
* g_list_free (node);
* }
* </programlisting>
* </example>
......
......@@ -29,10 +29,10 @@
*
* GhostPads are useful when organizing pipelines with #GstBin like elements.
* The idea here is to create hierarchical element graphs. The bin element
* contains a sub-graph. Now one would like to treat the bin-element like other
* #GstElements. This is where GhostPads come into play. A GhostPad acts as a
* proxy for another pad. Thus the bin can have sink and source ghost-pads that
* are associated with sink and source pads of the child elements.
* contains a sub-graph. Now one would like to treat the bin-element like any
* other #GstElement. This is where GhostPads come into play. A GhostPad acts as
* a proxy for another pad. Thus the bin can have sink and source ghost-pads
* that are associated with sink and source pads of the child elements.
*
* If the target pad is known at creation time, gst_ghost_pad_new() is the
* function to use to get a ghost-pad. Otherwise one can use gst_ghost_pad_new_no_target()
......@@ -1140,9 +1140,9 @@ gst_ghost_pad_new_no_target_from_template (const gchar * name,
/**
* gst_ghost_pad_get_target:
* @gpad: the #GstGhostpad
* @gpad: the #GstGhostPad
*
* Get the target pad of #gpad. Unref target pad after usage.
* Get the target pad of @gpad. Unref target pad after usage.
*
* Returns: the target #GstPad, can be NULL if the ghostpad
* has no target set. Unref target pad after usage.
......@@ -1163,7 +1163,7 @@ gst_ghost_pad_get_target (GstGhostPad * gpad)
/**
* gst_ghost_pad_set_target:
* @gpad: the #GstGhostpad
* @gpad: the #GstGhostPad
* @newtarget: the new pad target
*
* Set the new target of the ghostpad @gpad. Any existing target
......
......@@ -25,7 +25,7 @@
/**
* SECTION:gstinfo
* @short_description: Debugging and logging facilities
* @see_also: #GstConfig, #Gst for command line parameters
* @see_also: #gstreamer-gstconfig, #gstreamer-Gst for command line parameters
* and environment variables that affect the debugging output.
*
* GStreamer's debugging subsystem is an easy way to get information about what
......
......@@ -201,7 +201,7 @@ typedef enum
* @GST_STRUCTURE_CHANGE_TYPE_PAD_LINK: Pad linking is starting or done.
* @GST_STRUCTURE_CHANGE_TYPE_PAD_UNLINK: Pad unlinking is starting or done.
*
* The type of a #GstMessageStructureChange.
* The type of a %GST_MESSAGE_STRUCTURE_CHANGE.
*
* Since: 0.10.22
*/
......@@ -220,7 +220,7 @@ typedef enum {
* @GST_STREAM_STATUS_TYPE_PAUSE: a thread is paused
* @GST_STREAM_STATUS_TYPE_STOP: a thread is stopped
*
* The type of a #GstMessageStreamStatus. The stream status messages inform the
* The type of a %GST_MESSAGE_STREAM_STATUS. The stream status messages inform the
* application of new streaming threads and their status.
*
* Since: 0.10.24
......
......@@ -629,7 +629,7 @@ gst_param_spec_mini_object_get_type (void)
* @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
* @object_type: the #GstMiniObject #GType for the property
* @flags: a combination of #GParamFlags
*
* Creates a new #GParamSpec instance that hold #GstMiniObject references.
......
......@@ -99,7 +99,7 @@ typedef enum
#define GST_OBJECT_LOCK(obj) g_mutex_lock(GST_OBJECT_GET_LOCK(obj))
/**
* GST_OBJECT_TRYLOCK:
* @obj: a #Object.
* @obj: a #GstObject.
*
* This macro will try to obtain a lock on the object, but will return with
* FALSE if it can't get it immediately.
......
......@@ -3522,7 +3522,7 @@ gst_pad_event_default (GstPad * pad, GstEvent * event)
/**
* gst_pad_dispatcher:
* @pad: a #GstPad to dispatch.
* @dispatch: the #GstDispatcherFunction to call.
* @dispatch: the #GstPadDispatcherFunction to call.
* @data: gpointer user data passed to the dispatcher function.
*
* Invokes the given dispatcher function on each respective peer of
......
......@@ -41,7 +41,7 @@
* GST_PAD_TEMPLATE_DIRECTION().
*
* The GST_PAD_TEMPLATE_NAME_TEMPLATE () is important for GST_PAD_REQUEST pads
* because it has to be used as the name in the gst_element_request_pad_by_name()
* because it has to be used as the name in the gst_element_get_request_pad()
* call to instantiate a pad from this template.
*
* Padtemplates can be created with gst_pad_template_new() or with
......
......@@ -53,7 +53,7 @@ typedef struct _GstStaticPadTemplate GstStaticPadTemplate;
* @GST_PAD_ALWAYS: the pad is always available
* @GST_PAD_SOMETIMES: the pad will become available depending on the media stream
* @GST_PAD_REQUEST: the pad is only available on request with
* gst_element_request_pad_by_name() or gst_element_request_compatible_pad().
* gst_element_get_request_pad().
*
* Indicates when this pad will become available.
*/
......
......@@ -553,7 +553,8 @@ gst_pipeline_handle_message (GstBin * bin, GstMessage * message)
* gst_pipeline_get_bus:
* @pipeline: a #GstPipeline
*
* Gets the #GstBus of @pipeline. The bus allows applications to receive #GstMessages.
* Gets the #GstBus of @pipeline. The bus allows applications to receive
* #GstMessage packets.
*
* Returns: a #GstBus, unref after usage.
*
......
......@@ -101,11 +101,12 @@ typedef enum {
/**
* GstPluginInitFunc:
* @plugin: The plugin object that can be used to register #GstPluginFeatures for this plugin.
* @plugin: The plugin object
*
* A plugin should provide a pointer to a function of this type in the
* plugin_desc struct.
* This function will be called by the loader at startup.
* This function will be called by the loader at startup. One would then
* register each #GstPluginFeature.
*
* Returns: %TRUE if plugin initialised successfully
*/
......@@ -113,12 +114,12 @@ typedef gboolean (*GstPluginInitFunc) (GstPlugin *plugin);
/**
* GstPluginInitFullFunc:
* @plugin: The plugin object that can be used to register #GstPluginFeatures for this plugin.
* @user_data: The user data.
* @plugin: The plugin object
*
* A plugin should provide a pointer to a function of either #GstPluginInitFunc
* or this type in the plugin_desc struct.
* The function will be called by the loader at startup. This version allows
* The function will be called by the loader at startup. One would then
* register each #GstPluginFeature. This version allows
* user data to be passed to init function (useful for bindings).
*
* Returns: %TRUE if plugin initialised successfully
......
......@@ -226,8 +226,7 @@ gst_query_unref (GstQuery * q)
* gst_query_copy:
* @q: a #GstQuery to copy.
*
* Copies the given query using the copy function of the parent #GstData
* structure.
* Copies the given query using the copy function of the parent #GstStructure.
*
* Returns: a new copy of @q.
*/
......
......@@ -31,7 +31,7 @@
* <emphasis role="bold">Design:</emphasis>
*
* The #GstRegistry object is a list of plugins and some functions for dealing
* with them. #GstPlugins are matched 1-1 with a file on disk, and may or may
* with them. Each #GstPlugin is matched 1-1 with a file on disk, and may or may
* not be loaded at a given time. There may be multiple #GstRegistry objects,
* but the "default registry" is the only object that has any meaning to the
* core.
......
......@@ -1230,9 +1230,9 @@ gst_structure_get_uint (const GstStructure * structure,
* gst_structure_get_fourcc:
* @structure: a #GstStructure
* @fieldname: the name of a field
* @value: a pointer to a #GstFourcc to set
* @value: a pointer to a 32bit unsigned int to set
*
* Sets the #GstFourcc pointed to by @value corresponding to the value of the
* Sets the Fourcc pointed to by @value corresponding to the value of the
* given field. Caller is responsible for making sure the field exists
* and has the correct type.
*
......@@ -1344,7 +1344,7 @@ gst_structure_get_clock_time (const GstStructure * structure,
* gst_structure_get_double:
* @structure: a #GstStructure
* @fieldname: the name of a field
* @value: a pointer to a #GstFourcc to set
* @value: a pointer to a gdouble to set
*
* Sets the double pointed to by @value corresponding to the value of the
* given field. Caller is responsible for making sure the field exists
......
......@@ -376,7 +376,7 @@ gst_tag_lookup (GQuark entry)
* merge function was supplied and if so which one.
*
* Two default merge functions are provided: gst_tag_merge_use_first() and
* gst_tag_merge_strings_with_commas().
* gst_tag_merge_strings_with_comma().
*/
void
gst_tag_register (const gchar * name, GstTagFlag flag, GType type,
......
......@@ -180,7 +180,7 @@ gst_type_find_factory_get_caps (GstTypeFindFactory * factory)
*
* Gets the extensions associated with a #GstTypeFindFactory. The returned
* array should not be changed. If you need to change stuff in it, you should
* copy it using g_stdupv(). This function may return NULL to indicate
* copy it using g_strdupv(). This function may return NULL to indicate
* a 0-length list.
*
* Returns: a NULL-terminated array of extensions associated with this factory
......
......@@ -83,7 +83,7 @@ typedef struct _GstURIHandlerInterface GstURIHandlerInterface;
* get_protocols_full.
* Since: 0.10.15
*
* #GstElements using this interface should implement these methods.
* Any #GstElement using this interface should implement these methods.
*/
struct _GstURIHandlerInterface {
GTypeInterface parent;
......
......@@ -2269,7 +2269,7 @@ gst_element_seek_simple (GstElement * element, GstFormat format,
* pad. This way the function will always return the negotiated caps
* or in case the pad is not negotiated, the padtemplate caps.
*
* Use this function on a pad that, once _set_caps() has been called
* Use this function on a pad that, once gst_pad_set_caps() has been called
* on it, cannot be renegotiated to something else.
*/
void
......@@ -3649,7 +3649,7 @@ gst_parse_bin_from_description_full (const gchar * bin_description,
* Registers type_name as the name of a new static type derived from
* parent_type. The value of flags determines the nature (e.g. abstract or
* not) of the type. It works by filling a GTypeInfo struct and calling
* g_type_info_register_static().
* g_type_register_static().
*
* Returns: A #GType for the newly-registered type.
*
......@@ -3835,7 +3835,7 @@ gst_util_greatest_common_divisor (gint a, gint b)
* @src_d: Fraction denominator #gint
* @dest: pointer to a #gdouble for the result
*
* Transforms a #gdouble to a #GstFraction and simplifies
* Transforms a #gdouble to a GstFraction and simplifies
* the result.
*
* Since: 0.10.26
......@@ -3864,7 +3864,7 @@ gst_util_fraction_to_double (gint src_n, gint src_d, gdouble * dest)
* @dest_n: pointer to a #gint to hold the result numerator
* @dest_d: pointer to a #gint to hold the result denominator
*
* Transforms a #gdouble to a #GstFraction and simplifies
* Transforms a #gdouble to a fraction and simplifies
* the result.
*
* Since: 0.10.26
......
......@@ -24,8 +24,8 @@
*
* GValue implementations specific to GStreamer.
*
* Note that operations on the same GstValue (or GValue) from multiple
* threads may lead to undefined behaviour.
* Note that operations on the same #GValue from multiple threads may lead to
* undefined behaviour.
*
* Last reviewed on 2008-03-11 (0.10.18)
*/
......@@ -2904,7 +2904,7 @@ gst_value_can_compare (const GValue * value1, const GValue * value2)
* If @value1 is less than @value2, GST_VALUE_LESS_THAN is returned.
* If the values are equal, GST_VALUE_EQUAL is returned.
*
* Returns: A #GstValueCompareType value
* Returns: comparison result
*/
gint
gst_value_compare (const GValue * value1, const GValue * value2)
......@@ -2934,7 +2934,7 @@ gst_value_compare (const GValue * value1, const GValue * value2)
* gst_value_compare() but allows to save time determining the compare function
* a multiple times.
*
* Returns: A #GstValueCompareType value
* Returns: comparison result
*/
static gint
gst_value_compare_with_func (const GValue * value1, const GValue * value2,
......@@ -3032,7 +3032,7 @@ gst_value_union (GValue * dest, const GValue * value1, const GValue * value2)
* @type2: another type to union
* @func: a function that implments creating a union between the two types
*
* Registers a union function that can create a union between GValues
* Registers a union function that can create a union between #GValue items
* of the type @type1 and @type2.
*
* Union functions should be registered at startup before any pipelines are
......@@ -3061,7 +3061,7 @@ gst_value_register_union_func (GType type1, GType type2, GstValueUnionFunc func)
* Determines if intersecting two values will produce a valid result.
* Two values will produce a valid intersection if they have the same
* type, or if there is a method (registered by
* gst_value_register_intersection_func()) to calculate the intersection.
* gst_value_register_intersect_func()) to calculate the intersection.
*
* Returns: TRUE if the values can intersect
*/
......@@ -3310,7 +3310,7 @@ gst_value_register_subtract_func (GType minuend_type, GType subtrahend_type,
* gst_value_register:
* @table: structure containing functions to register
*
* Registers functions to perform calculations on #GValues of a given
* Registers functions to perform calculations on #GValue items of a given
* type. Each type can only be added once.
*/
void
......@@ -3597,7 +3597,7 @@ gst_value_get_fraction_denominator (const GValue * value)
* @factor1: a GValue initialized to #GST_TYPE_FRACTION
* @factor2: a GValue initialized to #GST_TYPE_FRACTION
*
* Multiplies the two GValues containing a GstFraction and sets @product
* Multiplies the two #GValue items containing a #GstFraction and sets @product
* to the product of the two fractions.
*
* Returns: FALSE in case of an error (like integer overflow), TRUE otherwise.
......
......@@ -296,7 +296,7 @@ G_BEGIN_DECLS
* @value1: first value for comparison
* @value2: second value for comparison
*
* Used together with gst_value_compare() to compare #GValues.
* Used together with gst_value_compare() to compare #GValue items.
*
* Returns: one of GST_VALUE_LESS_THAN, GST_VALUE_EQUAL, GST_VALUE_GREATER_THAN
* or GST_VALUE_UNORDERED
......@@ -351,7 +351,7 @@ typedef gboolean (* GstValueUnionFunc) (GValue *dest,
* type. If the intersection is non-empty, the result is
* placed in @dest and TRUE is returned. If the intersection is
* empty, @dest is unmodified and FALSE is returned.
* Register a new implementation with gst_value_register_intersection_func().
* Register a new implementation with gst_value_register_intersect_func().
*
* Returns: %TRUE if the values can intersect
*/
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment