mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-12-19 06:46:38 +00:00
ges: Fix docs for alignment and introspection annotations
gtk-doc comments need to have a space before the '*' of each line else they won't be picked up by gtk-doc.
This commit is contained in:
parent
75fbaa8e29
commit
50911c87a6
5 changed files with 51 additions and 50 deletions
|
@ -92,8 +92,9 @@ ges_custom_timeline_source_fill_track_object (GESTimelineObject * object,
|
|||
|
||||
/**
|
||||
* ges_custom_timeline_source_new:
|
||||
* @func: The #GESFillTrackObjectUserFunc that will be used to fill the track objects.
|
||||
* @user_data: a gpointer that will be used when @func is called.
|
||||
* @func: (scope notified): The #GESFillTrackObjectUserFunc that will be used to fill the track
|
||||
* objects.
|
||||
* @user_data: (closure): a gpointer that will be used when @func is called.
|
||||
*
|
||||
* Creates a new #GESCustomTimelineSource.
|
||||
*
|
||||
|
|
|
@ -857,18 +857,18 @@ sort_track_effects (gpointer a, gpointer b, GESTimelineObject * object)
|
|||
}
|
||||
|
||||
/**
|
||||
* ges_timeline_object_get_top_effects:
|
||||
* @object: The origin #GESTimelineObject
|
||||
*
|
||||
* Get effects applied on @object
|
||||
*
|
||||
* Returns: a #GList of the #GESTrackEffect that are applied on
|
||||
* @object order by ascendant priorities.
|
||||
* The refcount of the objects will be increased. The user will have to
|
||||
* unref each #GESTrackEffect and free the #GList.
|
||||
*
|
||||
* Since: 0.10.2
|
||||
*/
|
||||
* ges_timeline_object_get_top_effects:
|
||||
* @object: The origin #GESTimelineObject
|
||||
*
|
||||
* Get effects applied on @object
|
||||
*
|
||||
* Returns: (transfer full) (element-type GESTrackObject): a #GList of the
|
||||
* #GESTrackEffect that are applied on @object order by ascendant priorities.
|
||||
* The refcount of the objects will be increased. The user will have to
|
||||
* unref each #GESTrackEffect and free the #GList.
|
||||
*
|
||||
* Since: 0.10.2
|
||||
*/
|
||||
GList *
|
||||
ges_timeline_object_get_top_effects (GESTimelineObject * object)
|
||||
{
|
||||
|
@ -887,16 +887,16 @@ ges_timeline_object_get_top_effects (GESTimelineObject * object)
|
|||
}
|
||||
|
||||
/**
|
||||
* ges_timeline_object_get_top_effect_position:
|
||||
* @object: The origin #GESTimelineObject
|
||||
* @effect: The #GESTrackEffect we want to get the top position from
|
||||
*
|
||||
* Gets the top position of an effect.
|
||||
*
|
||||
* Returns: The top position of the effect, -1 if something went wrong.
|
||||
*
|
||||
* Since: 0.10.2
|
||||
*/
|
||||
* ges_timeline_object_get_top_effect_position:
|
||||
* @object: The origin #GESTimelineObject
|
||||
* @effect: The #GESTrackEffect we want to get the top position from
|
||||
*
|
||||
* Gets the top position of an effect.
|
||||
*
|
||||
* Returns: The top position of the effect, -1 if something went wrong.
|
||||
*
|
||||
* Since: 0.10.2
|
||||
*/
|
||||
gint
|
||||
ges_timeline_object_get_top_effect_position (GESTimelineObject * object,
|
||||
GESTrackEffect * effect)
|
||||
|
@ -906,18 +906,18 @@ ges_timeline_object_get_top_effect_position (GESTimelineObject * object,
|
|||
}
|
||||
|
||||
/**
|
||||
* ges_timeline_object_set_top_effect_priority:
|
||||
* @object: The origin #GESTimelineObject
|
||||
* @effect: The #GESTrackEffect to move
|
||||
* @newpriority: the new position at which to move the @effect inside this
|
||||
* #GESTimelineObject
|
||||
*
|
||||
* This is a convenience method that lets you set the priority of a top effect.
|
||||
*
|
||||
* Returns: %TRUE if @effect was successfuly moved, %FALSE otherwise.
|
||||
*
|
||||
* Since: 0.10.2
|
||||
*/
|
||||
* ges_timeline_object_set_top_effect_priority:
|
||||
* @object: The origin #GESTimelineObject
|
||||
* @effect: The #GESTrackEffect to move
|
||||
* @newpriority: the new position at which to move the @effect inside this
|
||||
* #GESTimelineObject
|
||||
*
|
||||
* This is a convenience method that lets you set the priority of a top effect.
|
||||
*
|
||||
* Returns: %TRUE if @effect was successfuly moved, %FALSE otherwise.
|
||||
*
|
||||
* Since: 0.10.2
|
||||
*/
|
||||
gboolean
|
||||
ges_timeline_object_set_top_effect_priority (GESTimelineObject * object,
|
||||
GESTrackEffect * effect, guint newpriority)
|
||||
|
|
|
@ -197,15 +197,15 @@ ges_tl_parse_launch_effect_create_track_obj (GESTimelineObject * self,
|
|||
}
|
||||
|
||||
/**
|
||||
* ges_timeline_parse_launch_effect_new:
|
||||
* @video_bin_description: The gst-launch like bin description of the effect
|
||||
* @audio_bin_description: The gst-launch like bin description of the effect
|
||||
*
|
||||
* Creates a new #GESTimelineParseLaunchEffect from the description of the bin.
|
||||
*
|
||||
* Returns: a newly created #GESTimelineParseLaunchEffect, or %NULL if something went
|
||||
* wrong.
|
||||
*/
|
||||
* ges_timeline_parse_launch_effect_new:
|
||||
* @video_bin_description: The gst-launch like bin description of the effect
|
||||
* @audio_bin_description: The gst-launch like bin description of the effect
|
||||
*
|
||||
* Creates a new #GESTimelineParseLaunchEffect from the description of the bin.
|
||||
*
|
||||
* Returns: (transfer full): a newly created #GESTimelineParseLaunchEffect, or
|
||||
* %NULL if something went wrong.
|
||||
*/
|
||||
GESTimelineParseLaunchEffect *
|
||||
ges_timeline_parse_launch_effect_new (const gchar * video_bin_description,
|
||||
const gchar * audio_bin_description)
|
||||
|
|
|
@ -882,7 +882,7 @@ ges_track_object_get_element (GESTrackObject * object)
|
|||
* Set the locking status of the @object in relationship to its controlling
|
||||
* #GESTimelineObject. If @locked is %TRUE, then this object will move synchronously
|
||||
* with its controlling #GESTimelineObject.
|
||||
*/
|
||||
*/
|
||||
void
|
||||
ges_track_object_set_locked (GESTrackObject * object, gboolean locked)
|
||||
{
|
||||
|
@ -1250,8 +1250,8 @@ cant_copy:
|
|||
* Gets an array of #GParamSpec* for all configurable properties of the
|
||||
* children of @object.
|
||||
*
|
||||
* Returns: (array): an array of #GParamSpec* which should be freed after use or %NULL
|
||||
* if something went wrong
|
||||
* Returns: (transfer full) (array): an array of #GParamSpec* which should be freed after use or
|
||||
* %NULL if something went wrong
|
||||
*/
|
||||
GParamSpec **
|
||||
ges_track_object_list_children_properties (GESTrackObject * object,
|
||||
|
|
|
@ -75,8 +75,8 @@ struct _GESTrackParseLaunchEffectClass
|
|||
|
||||
GType ges_track_parse_launch_effect_get_type (void);
|
||||
|
||||
GESTrackParseLaunchEffect
|
||||
*ges_track_parse_launch_effect_new (const gchar * bin_description);
|
||||
GESTrackParseLaunchEffect*
|
||||
ges_track_parse_launch_effect_new (const gchar * bin_description);
|
||||
|
||||
G_END_DECLS
|
||||
#endif /* _GES_TRACK_PARSE_LAUNCH_EFFECT */
|
||||
|
|
Loading…
Reference in a new issue