introspection: assorted introspection and documentation fixes

These changes are to clean up syntax issues such as missing colons,
missing spaces, etc., and minor issues such as argument names in
headers not matching the implementation and/or documentation.
This commit is contained in:
Evan Nemerson 2012-06-15 16:43:30 -07:00 committed by Wim Taymans
parent 49ba9ef056
commit 6c6bb0e217
16 changed files with 105 additions and 99 deletions

View file

@ -367,7 +367,7 @@ gst_bin_class_init (GstBinClass * klass)
gobject_class->get_property = gst_bin_get_property; gobject_class->get_property = gst_bin_get_property;
/** /**
* GstBin:async-handling * GstBin:async-handling:
* *
* If set to #TRUE, the bin will handle asynchronous state changes. * If set to #TRUE, the bin will handle asynchronous state changes.
* This should be used only if the bin subclass is modifying the state * This should be used only if the bin subclass is modifying the state
@ -427,7 +427,7 @@ gst_bin_class_init (GstBinClass * klass)
G_TYPE_BOOLEAN, 0, G_TYPE_NONE); G_TYPE_BOOLEAN, 0, G_TYPE_NONE);
/** /**
* GstBin:message-forward * GstBin:message-forward:
* *
* Forward all children messages, even those that would normally be filtered by * Forward all children messages, even those that would normally be filtered by
* the bin. This can be interesting when one wants to be notified of the EOS * the bin. This can be interesting when one wants to be notified of the EOS

View file

@ -874,9 +874,10 @@ gst_bus_add_watch_full_unlocked (GstBus * bus, gint priority,
* The watch can be removed using g_source_remove() or by returning FALSE * The watch can be removed using g_source_remove() or by returning FALSE
* from @func. * from @func.
* *
* MT safe.
*
* Returns: The event source id. * Returns: The event source id.
* Rename to: gst_bus_add_watch * Rename to: gst_bus_add_watch
* MT safe.
*/ */
guint guint
gst_bus_add_watch_full (GstBus * bus, gint priority, gst_bus_add_watch_full (GstBus * bus, gint priority,

View file

@ -458,32 +458,32 @@ gst_child_proxy_set (GstChildProxy * object, const gchar * first_property_name,
/** /**
* gst_child_proxy_child_added: * gst_child_proxy_child_added:
* @object: the parent object * @parent: the parent object
* @child: the newly added child * @child: the newly added child
* @name: the name of the new child * @name: the name of the new child
* *
* Emits the "child-added" signal. * Emits the "child-added" signal.
*/ */
void void
gst_child_proxy_child_added (GstChildProxy * object, GObject * child, gst_child_proxy_child_added (GstChildProxy * parent, GObject * child,
const gchar * name) const gchar * name)
{ {
g_signal_emit (object, signals[CHILD_ADDED], 0, child, name); g_signal_emit (parent, signals[CHILD_ADDED], 0, child, name);
} }
/** /**
* gst_child_proxy_child_removed: * gst_child_proxy_child_removed:
* @object: the parent object * @parent: the parent object
* @child: the removed child * @child: the removed child
* @name: the name of the old child * @name: the name of the old child
* *
* Emits the "child-removed" signal. * Emits the "child-removed" signal.
*/ */
void void
gst_child_proxy_child_removed (GstChildProxy * object, GObject * child, gst_child_proxy_child_removed (GstChildProxy * parent, GObject * child,
const gchar * name) const gchar * name)
{ {
g_signal_emit (object, signals[CHILD_REMOVED], 0, child, name); g_signal_emit (parent, signals[CHILD_REMOVED], 0, child, name);
} }
/* gobject methods */ /* gobject methods */

View file

@ -95,9 +95,9 @@ void gst_child_proxy_set (GstChildProxy * object,
const gchar * first_property_name, const gchar * first_property_name,
...) G_GNUC_NULL_TERMINATED; ...) G_GNUC_NULL_TERMINATED;
void gst_child_proxy_child_added (GstChildProxy * object, GObject * child, void gst_child_proxy_child_added (GstChildProxy * parent, GObject * child,
const gchar *name); const gchar *name);
void gst_child_proxy_child_removed (GstChildProxy * object, GObject * child, void gst_child_proxy_child_removed (GstChildProxy * parent, GObject * child,
const gchar *name); const gchar *name);
G_END_DECLS G_END_DECLS

View file

@ -413,7 +413,7 @@ gst_clock_new_periodic_id (GstClock * clock, GstClockTime start_time,
} }
/** /**
* gst_clock_id_compare_func * gst_clock_id_compare_func:
* @id1: A #GstClockID * @id1: A #GstClockID
* @id2: A #GstClockID to compare with * @id2: A #GstClockID to compare with
* *
@ -442,7 +442,7 @@ gst_clock_id_compare_func (gconstpointer id1, gconstpointer id2)
} }
/** /**
* gst_clock_id_get_time * gst_clock_id_get_time:
* @id: The #GstClockID to query * @id: The #GstClockID to query
* *
* Get the time of the clock ID * Get the time of the clock ID
@ -460,7 +460,7 @@ gst_clock_id_get_time (GstClockID id)
} }
/** /**
* gst_clock_id_wait * gst_clock_id_wait:
* @id: The #GstClockID to wait on * @id: The #GstClockID to wait on
* @jitter: (out) (allow-none): a pointer that will contain the jitter, * @jitter: (out) (allow-none): a pointer that will contain the jitter,
* can be %NULL. * can be %NULL.
@ -762,7 +762,7 @@ gst_clock_finalize (GObject * object)
} }
/** /**
* gst_clock_set_resolution * gst_clock_set_resolution:
* @clock: a #GstClock * @clock: a #GstClock
* @resolution: The resolution to set * @resolution: The resolution to set
* *
@ -794,7 +794,7 @@ gst_clock_set_resolution (GstClock * clock, GstClockTime resolution)
} }
/** /**
* gst_clock_get_resolution * gst_clock_get_resolution:
* @clock: a #GstClock * @clock: a #GstClock
* *
* Get the accuracy of the clock. The accuracy of the clock is the granularity * Get the accuracy of the clock. The accuracy of the clock is the granularity
@ -820,7 +820,7 @@ gst_clock_get_resolution (GstClock * clock)
} }
/** /**
* gst_clock_adjust_unlocked * gst_clock_adjust_unlocked:
* @clock: a #GstClock to use * @clock: a #GstClock to use
* @internal: a clock time * @internal: a clock time
* *
@ -876,7 +876,7 @@ gst_clock_adjust_unlocked (GstClock * clock, GstClockTime internal)
} }
/** /**
* gst_clock_unadjust_unlocked * gst_clock_unadjust_unlocked:
* @clock: a #GstClock to use * @clock: a #GstClock to use
* @external: an external clock time * @external: an external clock time
* *
@ -924,7 +924,7 @@ gst_clock_unadjust_unlocked (GstClock * clock, GstClockTime external)
} }
/** /**
* gst_clock_get_internal_time * gst_clock_get_internal_time:
* @clock: a #GstClock to query * @clock: a #GstClock to query
* *
* Gets the current internal time of the given clock. The time is returned * Gets the current internal time of the given clock. The time is returned
@ -965,7 +965,7 @@ not_supported:
} }
/** /**
* gst_clock_get_time * gst_clock_get_time:
* @clock: a #GstClock to query * @clock: a #GstClock to query
* *
* Gets the current time of the given clock. The time is always * Gets the current time of the given clock. The time is always
@ -1002,7 +1002,7 @@ gst_clock_get_time (GstClock * clock)
} }
/** /**
* gst_clock_set_calibration * gst_clock_set_calibration:
* @clock: a #GstClock to calibrate * @clock: a #GstClock to calibrate
* @internal: a reference internal time * @internal: a reference internal time
* @external: a reference external time * @external: a reference external time
@ -1061,7 +1061,7 @@ gst_clock_set_calibration (GstClock * clock, GstClockTime internal, GstClockTime
} }
/** /**
* gst_clock_get_calibration * gst_clock_get_calibration:
* @clock: a #GstClock * @clock: a #GstClock
* @internal: (out) (allow-none): a location to store the internal time * @internal: (out) (allow-none): a location to store the internal time
* @external: (out) (allow-none): a location to store the external time * @external: (out) (allow-none): a location to store the external time
@ -1125,7 +1125,7 @@ gst_clock_slave_callback (GstClock * master, GstClockTime time,
} }
/** /**
* gst_clock_set_master * gst_clock_set_master:
* @clock: a #GstClock * @clock: a #GstClock
* @master: (allow-none): a master #GstClock * @master: (allow-none): a master #GstClock
* *
@ -1358,7 +1358,7 @@ invalid:
} }
/** /**
* gst_clock_add_observation * gst_clock_add_observation:
* @clock: a #GstClock * @clock: a #GstClock
* @slave: a time on the slave * @slave: a time on the slave
* @master: a time on the master * @master: a time on the master

View file

@ -103,7 +103,7 @@ gst_control_binding_class_init (GstControlBindingClass * klass)
} }
static void static void
gst_control_binding_init (GstControlBinding * self) gst_control_binding_init (GstControlBinding * binding)
{ {
} }
@ -111,32 +111,33 @@ static GObject *
gst_control_binding_constructor (GType type, guint n_construct_params, gst_control_binding_constructor (GType type, guint n_construct_params,
GObjectConstructParam * construct_params) GObjectConstructParam * construct_params)
{ {
GstControlBinding *self; GstControlBinding *binding;
GParamSpec *pspec; GParamSpec *pspec;
self = GST_CONTROL_BINDING (G_OBJECT_CLASS (gst_control_binding_parent_class) binding =
GST_CONTROL_BINDING (G_OBJECT_CLASS (gst_control_binding_parent_class)
->constructor (type, n_construct_params, construct_params)); ->constructor (type, n_construct_params, construct_params));
GST_INFO_OBJECT (self->object, "trying to put property '%s' under control", GST_INFO_OBJECT (binding->object, "trying to put property '%s' under control",
self->name); binding->name);
/* check if the object has a property of that name */ /* check if the object has a property of that name */
if ((pspec = if ((pspec =
g_object_class_find_property (G_OBJECT_GET_CLASS (self->object), g_object_class_find_property (G_OBJECT_GET_CLASS (binding->object),
self->name))) { binding->name))) {
GST_DEBUG_OBJECT (self->object, " psec->flags : 0x%08x", pspec->flags); GST_DEBUG_OBJECT (binding->object, " psec->flags : 0x%08x", pspec->flags);
/* check if this param is witable && controlable && !construct-only */ /* check if this param is witable && controlable && !construct-only */
if ((pspec->flags & (G_PARAM_WRITABLE | GST_PARAM_CONTROLLABLE | if ((pspec->flags & (G_PARAM_WRITABLE | GST_PARAM_CONTROLLABLE |
G_PARAM_CONSTRUCT_ONLY)) == G_PARAM_CONSTRUCT_ONLY)) ==
(G_PARAM_WRITABLE | GST_PARAM_CONTROLLABLE)) { (G_PARAM_WRITABLE | GST_PARAM_CONTROLLABLE)) {
self->pspec = pspec; binding->pspec = pspec;
} }
} else { } else {
GST_WARNING_OBJECT (self->object, "class '%s' has no property '%s'", GST_WARNING_OBJECT (binding->object, "class '%s' has no property '%s'",
G_OBJECT_TYPE_NAME (self->object), self->name); G_OBJECT_TYPE_NAME (binding->object), binding->name);
} }
return (GObject *) self; return (GObject *) binding;
} }
static void static void
@ -207,7 +208,7 @@ gst_control_binding_get_property (GObject * object, guint prop_id,
/** /**
* gst_control_binding_sync_values: * gst_control_binding_sync_values:
* @self: the control binding * @binding: the control binding
* @object: the object that has controlled properties * @object: the object that has controlled properties
* @timestamp: the time that should be processed * @timestamp: the time that should be processed
* @last_sync: the last time this was called * @last_sync: the last time this was called
@ -222,30 +223,30 @@ gst_control_binding_get_property (GObject * object, guint prop_id,
* property, %FALSE otherwise * property, %FALSE otherwise
*/ */
gboolean gboolean
gst_control_binding_sync_values (GstControlBinding * self, GstObject * object, gst_control_binding_sync_values (GstControlBinding * binding,
GstClockTime timestamp, GstClockTime last_sync) GstObject * object, GstClockTime timestamp, GstClockTime last_sync)
{ {
GstControlBindingClass *klass; GstControlBindingClass *klass;
gboolean ret = FALSE; gboolean ret = FALSE;
g_return_val_if_fail (GST_IS_CONTROL_BINDING (self), FALSE); g_return_val_if_fail (GST_IS_CONTROL_BINDING (binding), FALSE);
if (self->disabled) if (binding->disabled)
return TRUE; return TRUE;
klass = GST_CONTROL_BINDING_GET_CLASS (self); klass = GST_CONTROL_BINDING_GET_CLASS (binding);
if (G_LIKELY (klass->sync_values != NULL)) { if (G_LIKELY (klass->sync_values != NULL)) {
ret = klass->sync_values (self, object, timestamp, last_sync); ret = klass->sync_values (binding, object, timestamp, last_sync);
} else { } else {
GST_WARNING_OBJECT (self, "missing sync_values implementation"); GST_WARNING_OBJECT (binding, "missing sync_values implementation");
} }
return ret; return ret;
} }
/** /**
* gst_control_binding_get_value: * gst_control_binding_get_value:
* @self: the control binding * @binding: the control binding
* @timestamp: the time the control-change should be read from * @timestamp: the time the control-change should be read from
* *
* Gets the value for the given controlled property at the requested time. * Gets the value for the given controlled property at the requested time.
@ -254,27 +255,28 @@ gst_control_binding_sync_values (GstControlBinding * self, GstObject * object,
* property isn't controlled. * property isn't controlled.
*/ */
GValue * GValue *
gst_control_binding_get_value (GstControlBinding * self, GstClockTime timestamp) gst_control_binding_get_value (GstControlBinding * binding,
GstClockTime timestamp)
{ {
GstControlBindingClass *klass; GstControlBindingClass *klass;
GValue *ret = NULL; GValue *ret = NULL;
g_return_val_if_fail (GST_IS_CONTROL_BINDING (self), NULL); g_return_val_if_fail (GST_IS_CONTROL_BINDING (binding), NULL);
g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (timestamp), NULL); g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (timestamp), NULL);
klass = GST_CONTROL_BINDING_GET_CLASS (self); klass = GST_CONTROL_BINDING_GET_CLASS (binding);
if (G_LIKELY (klass->get_value != NULL)) { if (G_LIKELY (klass->get_value != NULL)) {
ret = klass->get_value (self, timestamp); ret = klass->get_value (binding, timestamp);
} else { } else {
GST_WARNING_OBJECT (self, "missing get_value implementation"); GST_WARNING_OBJECT (binding, "missing get_value implementation");
} }
return ret; return ret;
} }
/** /**
* gst_control_binding_get_value_array: * gst_control_binding_get_value_array:
* @self: the control binding * @binding: the control binding
* @timestamp: the time that should be processed * @timestamp: the time that should be processed
* @interval: the time spacing between subsequent values * @interval: the time spacing between subsequent values
* @n_values: the number of values * @n_values: the number of values
@ -294,24 +296,25 @@ gst_control_binding_get_value (GstControlBinding * self, GstClockTime timestamp)
* Returns: %TRUE if the given array could be filled, %FALSE otherwise * Returns: %TRUE if the given array could be filled, %FALSE otherwise
*/ */
gboolean gboolean
gst_control_binding_get_value_array (GstControlBinding * self, gst_control_binding_get_value_array (GstControlBinding * binding,
GstClockTime timestamp, GstClockTime interval, guint n_values, GstClockTime timestamp, GstClockTime interval, guint n_values,
gpointer values) gpointer values)
{ {
GstControlBindingClass *klass; GstControlBindingClass *klass;
gboolean ret = FALSE; gboolean ret = FALSE;
g_return_val_if_fail (GST_IS_CONTROL_BINDING (self), FALSE); g_return_val_if_fail (GST_IS_CONTROL_BINDING (binding), FALSE);
g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (timestamp), FALSE); g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (timestamp), FALSE);
g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (interval), FALSE); g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (interval), FALSE);
g_return_val_if_fail (values, FALSE); g_return_val_if_fail (values, FALSE);
klass = GST_CONTROL_BINDING_GET_CLASS (self); klass = GST_CONTROL_BINDING_GET_CLASS (binding);
if (G_LIKELY (klass->get_value_array != NULL)) { if (G_LIKELY (klass->get_value_array != NULL)) {
ret = klass->get_value_array (self, timestamp, interval, n_values, values); ret =
klass->get_value_array (binding, timestamp, interval, n_values, values);
} else { } else {
GST_WARNING_OBJECT (self, "missing get_value_array implementation"); GST_WARNING_OBJECT (binding, "missing get_value_array implementation");
} }
return ret; return ret;
} }
@ -319,7 +322,7 @@ gst_control_binding_get_value_array (GstControlBinding * self,
#define CONVERT_ARRAY(type,TYPE) \ #define CONVERT_ARRAY(type,TYPE) \
{ \ { \
g##type *v = g_new (g##type,n_values); \ g##type *v = g_new (g##type,n_values); \
ret = gst_control_binding_get_value_array (self, timestamp, interval, \ ret = gst_control_binding_get_value_array (binding, timestamp, interval, \
n_values, v); \ n_values, v); \
if (ret) { \ if (ret) { \
for (i = 0; i < n_values; i++) { \ for (i = 0; i < n_values; i++) { \
@ -332,7 +335,7 @@ gst_control_binding_get_value_array (GstControlBinding * self,
/** /**
* gst_control_binding_get_g_value_array: * gst_control_binding_get_g_value_array:
* @self: the control binding * @binding: the control binding
* @timestamp: the time that should be processed * @timestamp: the time that should be processed
* @interval: the time spacing between subsequent values * @interval: the time spacing between subsequent values
* @n_values: the number of values * @n_values: the number of values
@ -348,32 +351,33 @@ gst_control_binding_get_value_array (GstControlBinding * self,
* Returns: %TRUE if the given array could be filled, %FALSE otherwise * Returns: %TRUE if the given array could be filled, %FALSE otherwise
*/ */
gboolean gboolean
gst_control_binding_get_g_value_array (GstControlBinding * self, gst_control_binding_get_g_value_array (GstControlBinding * binding,
GstClockTime timestamp, GstClockTime interval, guint n_values, GstClockTime timestamp, GstClockTime interval, guint n_values,
GValue * values) GValue * values)
{ {
GstControlBindingClass *klass; GstControlBindingClass *klass;
gboolean ret = FALSE; gboolean ret = FALSE;
g_return_val_if_fail (GST_IS_CONTROL_BINDING (self), FALSE); g_return_val_if_fail (GST_IS_CONTROL_BINDING (binding), FALSE);
g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (timestamp), FALSE); g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (timestamp), FALSE);
g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (interval), FALSE); g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (interval), FALSE);
g_return_val_if_fail (values, FALSE); g_return_val_if_fail (values, FALSE);
klass = GST_CONTROL_BINDING_GET_CLASS (self); klass = GST_CONTROL_BINDING_GET_CLASS (binding);
if (G_LIKELY (klass->get_g_value_array != NULL)) { if (G_LIKELY (klass->get_g_value_array != NULL)) {
ret = ret =
klass->get_g_value_array (self, timestamp, interval, n_values, values); klass->get_g_value_array (binding, timestamp, interval, n_values,
values);
} else { } else {
guint i; guint i;
GType type, base; GType type, base;
base = type = G_PARAM_SPEC_VALUE_TYPE (GST_CONTROL_BINDING_PSPEC (self)); base = type = G_PARAM_SPEC_VALUE_TYPE (GST_CONTROL_BINDING_PSPEC (binding));
while ((type = g_type_parent (type))) while ((type = g_type_parent (type)))
base = type; base = type;
GST_INFO_OBJECT (self, "missing get_g_value_array implementation, we're " GST_INFO_OBJECT (binding, "missing get_g_value_array implementation, we're "
"emulating it"); "emulating it");
switch (base) { switch (base) {
case G_TYPE_INT: case G_TYPE_INT:
@ -406,7 +410,7 @@ gst_control_binding_get_g_value_array (GstControlBinding * self,
case G_TYPE_ENUM: case G_TYPE_ENUM:
{ {
gint *v = g_new (gint, n_values); gint *v = g_new (gint, n_values);
ret = gst_control_binding_get_value_array (self, timestamp, interval, ret = gst_control_binding_get_value_array (binding, timestamp, interval,
n_values, v); n_values, v);
if (ret) { if (ret) {
for (i = 0; i < n_values; i++) { for (i = 0; i < n_values; i++) {
@ -419,8 +423,8 @@ gst_control_binding_get_g_value_array (GstControlBinding * self,
break; break;
default: default:
GST_WARNING ("incomplete implementation for paramspec type '%s'", GST_WARNING ("incomplete implementation for paramspec type '%s'",
G_PARAM_SPEC_TYPE_NAME (GST_CONTROL_BINDING_PSPEC (self))); G_PARAM_SPEC_TYPE_NAME (GST_CONTROL_BINDING_PSPEC (binding)));
GST_CONTROL_BINDING_PSPEC (self) = NULL; GST_CONTROL_BINDING_PSPEC (binding) = NULL;
break; break;
} }
} }
@ -429,7 +433,7 @@ gst_control_binding_get_g_value_array (GstControlBinding * self,
/** /**
* gst_control_binding_set_disabled: * gst_control_binding_set_disabled:
* @self: the control binding * @binding: the control binding
* @disabled: boolean that specifies whether to disable the controller * @disabled: boolean that specifies whether to disable the controller
* or not. * or not.
* *
@ -437,23 +441,24 @@ gst_control_binding_get_g_value_array (GstControlBinding * self,
* gst_object_sync_values() will do nothing. * gst_object_sync_values() will do nothing.
*/ */
void void
gst_control_binding_set_disabled (GstControlBinding * self, gboolean disabled) gst_control_binding_set_disabled (GstControlBinding * binding,
gboolean disabled)
{ {
g_return_if_fail (GST_IS_CONTROL_BINDING (self)); g_return_if_fail (GST_IS_CONTROL_BINDING (binding));
self->disabled = disabled; binding->disabled = disabled;
} }
/** /**
* gst_control_binding_is_disabled: * gst_control_binding_is_disabled:
* @self: the control binding * @binding: the control binding
* *
* Check if the control binding is disabled. * Check if the control binding is disabled.
* *
* Returns: %TRUE if the binding is inactive * Returns: %TRUE if the binding is inactive
*/ */
gboolean gboolean
gst_control_binding_is_disabled (GstControlBinding * self) gst_control_binding_is_disabled (GstControlBinding * binding)
{ {
g_return_val_if_fail (GST_IS_CONTROL_BINDING (self), TRUE); g_return_val_if_fail (GST_IS_CONTROL_BINDING (binding), TRUE);
return (self->disabled == TRUE); return (binding->disabled == TRUE);
} }

View file

@ -49,13 +49,13 @@ typedef struct _GstControlBindingClass GstControlBindingClass;
/** /**
* GstControlBindingConvert: * GstControlBindingConvert:
* @self: the #GstControlBinding instance * @binding: the #GstControlBinding instance
* @src_value: the value returned by the cotnrol source * @src_value: the value returned by the cotnrol source
* @dest_value: the target GValue * @dest_value: the target GValue
* *
* Function to map a control-value to the target GValue. * Function to map a control-value to the target GValue.
*/ */
typedef void (* GstControlBindingConvert) (GstControlBinding *self, gdouble src_value, GValue *dest_value); typedef void (* GstControlBindingConvert) (GstControlBinding *binding, gdouble src_value, GValue *dest_value);
/** /**
* GstControlBinding: * GstControlBinding:
@ -91,10 +91,10 @@ struct _GstControlBindingClass
GstObjectClass parent_class; GstObjectClass parent_class;
/* virtual methods */ /* virtual methods */
gboolean (* sync_values) (GstControlBinding *self, GstObject *object, GstClockTime timestamp, GstClockTime last_sync); gboolean (* sync_values) (GstControlBinding *binding, GstObject *object, GstClockTime timestamp, GstClockTime last_sync);
GValue * (* get_value) (GstControlBinding *self, GstClockTime timestamp); GValue * (* get_value) (GstControlBinding *binding, GstClockTime timestamp);
gboolean (* get_value_array) (GstControlBinding *self, GstClockTime timestamp,GstClockTime interval, guint n_values, gpointer values); gboolean (* get_value_array) (GstControlBinding *binding, GstClockTime timestamp,GstClockTime interval, guint n_values, gpointer values);
gboolean (* get_g_value_array) (GstControlBinding *self, GstClockTime timestamp,GstClockTime interval, guint n_values, GValue *values); gboolean (* get_g_value_array) (GstControlBinding *binding, GstClockTime timestamp,GstClockTime interval, guint n_values, GValue *values);
/*< private >*/ /*< private >*/
gpointer _gst_reserved[GST_PADDING]; gpointer _gst_reserved[GST_PADDING];
@ -106,7 +106,7 @@ GType gst_control_binding_get_type (void);
/* Functions */ /* Functions */
gboolean gst_control_binding_sync_values (GstControlBinding * self, GstObject *object, gboolean gst_control_binding_sync_values (GstControlBinding * binding, GstObject *object,
GstClockTime timestamp, GstClockTime last_sync); GstClockTime timestamp, GstClockTime last_sync);
GValue * gst_control_binding_get_value (GstControlBinding *binding, GValue * gst_control_binding_get_value (GstControlBinding *binding,
GstClockTime timestamp); GstClockTime timestamp);
@ -115,8 +115,8 @@ gboolean gst_control_binding_get_value_array (GstControlBinding *b
gboolean gst_control_binding_get_g_value_array (GstControlBinding *binding, GstClockTime timestamp, gboolean gst_control_binding_get_g_value_array (GstControlBinding *binding, GstClockTime timestamp,
GstClockTime interval, guint n_values, GValue *values); GstClockTime interval, guint n_values, GValue *values);
void gst_control_binding_set_disabled (GstControlBinding * self, gboolean disabled); void gst_control_binding_set_disabled (GstControlBinding * binding, gboolean disabled);
gboolean gst_control_binding_is_disabled (GstControlBinding * self); gboolean gst_control_binding_is_disabled (GstControlBinding * binding);
G_END_DECLS G_END_DECLS
#endif /* __GST_CONTROL_BINDING_H__ */ #endif /* __GST_CONTROL_BINDING_H__ */

View file

@ -120,7 +120,7 @@ gst_control_source_get_value (GstControlSource * self, GstClockTime timestamp,
* @timestamp: the first timestamp * @timestamp: the first timestamp
* @interval: the time steps * @interval: the time steps
* @n_values: the number of values to fetch * @n_values: the number of values to fetch
* @value_array: array to put control-values in * @values: array to put control-values in
* *
* Gets an array of values for for this #GstControlSource. Values that are * Gets an array of values for for this #GstControlSource. Values that are
* undefined contain NANs. * undefined contain NANs.

View file

@ -63,7 +63,7 @@ struct _GstTimedValue
}; };
/** /**
* GstControlSourceGetValue * GstControlSourceGetValue:
* @self: the #GstControlSource instance * @self: the #GstControlSource instance
* @timestamp: timestamp for which a value should be calculated * @timestamp: timestamp for which a value should be calculated
* @value: a #GValue which will be set to the result. It must be initialized to the correct type. * @value: a #GValue which will be set to the result. It must be initialized to the correct type.
@ -77,7 +77,7 @@ typedef gboolean (* GstControlSourceGetValue) (GstControlSource *self,
GstClockTime timestamp, gdouble *value); GstClockTime timestamp, gdouble *value);
/** /**
* GstControlSourceGetValueArray * GstControlSourceGetValueArray:
* @self: the #GstControlSource instance * @self: the #GstControlSource instance
* @timestamp: timestamp for which a value should be calculated * @timestamp: timestamp for which a value should be calculated
* @interval: the time spacing between subsequent values * @interval: the time spacing between subsequent values

View file

@ -1610,7 +1610,7 @@ gst_event_parse_sink_message (GstEvent * event, GstMessage ** msg)
} }
/** /**
* gst_event_new_stream_start * gst_event_new_stream_start:
* *
* Create a new STREAM_START event. The stream start event can only * Create a new STREAM_START event. The stream start event can only
* travel downstream synchronized with the buffer flow. It is expected * travel downstream synchronized with the buffer flow. It is expected

View file

@ -478,7 +478,7 @@ gst_object_dispatch_properties_changed (GObject * object,
* @orig: a #GstObject that initiated the notify. * @orig: a #GstObject that initiated the notify.
* @pspec: a #GParamSpec of the property. * @pspec: a #GParamSpec of the property.
* @excluded_props: (array zero-terminated=1) (element-type gchar*) * @excluded_props: (array zero-terminated=1) (element-type gchar*)
* (allow-none):a set of user-specified properties to exclude or * (allow-none): a set of user-specified properties to exclude or
* NULL to show all changes. * NULL to show all changes.
* *
* A default deep_notify signal callback for an object. The user data * A default deep_notify signal callback for an object. The user data

View file

@ -405,7 +405,7 @@ typedef gboolean (*GstPadQueryFunction) (GstPad *pad, GstObject *parent,
/* linking */ /* linking */
/** /**
* GstPadLinkFunction * GstPadLinkFunction:
* @pad: the #GstPad that is linked. * @pad: the #GstPad that is linked.
* @peer: the peer #GstPad of the link * @peer: the peer #GstPad of the link
* *
@ -415,7 +415,7 @@ typedef gboolean (*GstPadQueryFunction) (GstPad *pad, GstObject *parent,
*/ */
typedef GstPadLinkReturn (*GstPadLinkFunction) (GstPad *pad, GstPad *peer); typedef GstPadLinkReturn (*GstPadLinkFunction) (GstPad *pad, GstPad *peer);
/** /**
* GstPadUnlinkFunction * GstPadUnlinkFunction:
* @pad: the #GstPad that is linked. * @pad: the #GstPad that is linked.
* *
* Function signature to handle a unlinking the pad prom its peer. * Function signature to handle a unlinking the pad prom its peer.
@ -553,7 +553,7 @@ struct _GstPadProbeInfo
#define GST_PAD_PROBE_INFO_SIZE(d) ((d)->size) #define GST_PAD_PROBE_INFO_SIZE(d) ((d)->size)
/** /**
* GstPadProbeCallback * GstPadProbeCallback:
* @pad: the #GstPad that is blocked * @pad: the #GstPad that is blocked
* @info: #GstPadProbeInfo * @info: #GstPadProbeInfo
* @user_data: the gpointer to optional user data. * @user_data: the gpointer to optional user data.

View file

@ -160,7 +160,7 @@ gst_pad_template_class_init (GstPadTemplateClass * klass)
gobject_class->set_property = gst_pad_template_set_property; gobject_class->set_property = gst_pad_template_set_property;
/** /**
* GstPadTemplate:name-template * GstPadTemplate:name-template:
* *
* The name template of the pad template. * The name template of the pad template.
* *
@ -172,7 +172,7 @@ gst_pad_template_class_init (GstPadTemplateClass * klass)
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS)); G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
/** /**
* GstPadTemplate:direction * GstPadTemplate:direction:
* *
* The direction of the pad described by the pad template. * The direction of the pad described by the pad template.
* *
@ -185,7 +185,7 @@ gst_pad_template_class_init (GstPadTemplateClass * klass)
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS)); G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
/** /**
* GstPadTemplate:presence * GstPadTemplate:presence:
* *
* When the pad described by the pad template will become available. * When the pad described by the pad template will become available.
* *
@ -198,7 +198,7 @@ gst_pad_template_class_init (GstPadTemplateClass * klass)
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS)); G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
/** /**
* GstPadTemplate:caps * GstPadTemplate:caps:
* *
* The capabilities of the pad described by the pad template. * The capabilities of the pad described by the pad template.
* *

View file

@ -155,7 +155,7 @@ gst_pipeline_class_init (GstPipelineClass * klass)
gobject_class->get_property = gst_pipeline_get_property; gobject_class->get_property = gst_pipeline_get_property;
/** /**
* GstPipeline:delay * GstPipeline:delay:
* *
* The expected delay needed for elements to spin up to the * The expected delay needed for elements to spin up to the
* PLAYING state expressed in nanoseconds. * PLAYING state expressed in nanoseconds.

View file

@ -580,7 +580,7 @@ gst_tag_get_type (const gchar * tag)
} }
/** /**
* gst_tag_get_nick * gst_tag_get_nick:
* @tag: the tag * @tag: the tag
* *
* Returns the human-readable name of this tag, You must not change or free * Returns the human-readable name of this tag, You must not change or free

View file

@ -2339,7 +2339,7 @@ gst_element_query_convert (GstElement * element, GstFormat src_format,
} }
/** /**
* gst_element_seek_simple * gst_element_seek_simple:
* @element: a #GstElement to seek on * @element: a #GstElement to seek on
* @format: a #GstFormat to execute the seek in, such as #GST_FORMAT_TIME * @format: a #GstFormat to execute the seek in, such as #GST_FORMAT_TIME
* @seek_flags: seek options; playback applications will usually want to use * @seek_flags: seek options; playback applications will usually want to use