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:
Edward Hervey 2011-05-07 16:59:06 +02:00
parent 75fbaa8e29
commit 50911c87a6
5 changed files with 51 additions and 50 deletions

View file

@ -92,8 +92,9 @@ ges_custom_timeline_source_fill_track_object (GESTimelineObject * object,
/** /**
* ges_custom_timeline_source_new: * ges_custom_timeline_source_new:
* @func: The #GESFillTrackObjectUserFunc that will be used to fill the track objects. * @func: (scope notified): The #GESFillTrackObjectUserFunc that will be used to fill the track
* @user_data: a gpointer that will be used when @func is called. * objects.
* @user_data: (closure): a gpointer that will be used when @func is called.
* *
* Creates a new #GESCustomTimelineSource. * Creates a new #GESCustomTimelineSource.
* *

View file

@ -857,18 +857,18 @@ sort_track_effects (gpointer a, gpointer b, GESTimelineObject * object)
} }
/** /**
* ges_timeline_object_get_top_effects: * ges_timeline_object_get_top_effects:
* @object: The origin #GESTimelineObject * @object: The origin #GESTimelineObject
* *
* Get effects applied on @object * Get effects applied on @object
* *
* Returns: a #GList of the #GESTrackEffect that are applied on * Returns: (transfer full) (element-type GESTrackObject): a #GList of the
* @object order by ascendant priorities. * #GESTrackEffect that are applied on @object order by ascendant priorities.
* The refcount of the objects will be increased. The user will have to * The refcount of the objects will be increased. The user will have to
* unref each #GESTrackEffect and free the #GList. * unref each #GESTrackEffect and free the #GList.
* *
* Since: 0.10.2 * Since: 0.10.2
*/ */
GList * GList *
ges_timeline_object_get_top_effects (GESTimelineObject * object) 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: * ges_timeline_object_get_top_effect_position:
* @object: The origin #GESTimelineObject * @object: The origin #GESTimelineObject
* @effect: The #GESTrackEffect we want to get the top position from * @effect: The #GESTrackEffect we want to get the top position from
* *
* Gets the top position of an effect. * Gets the top position of an effect.
* *
* Returns: The top position of the effect, -1 if something went wrong. * Returns: The top position of the effect, -1 if something went wrong.
* *
* Since: 0.10.2 * Since: 0.10.2
*/ */
gint gint
ges_timeline_object_get_top_effect_position (GESTimelineObject * object, ges_timeline_object_get_top_effect_position (GESTimelineObject * object,
GESTrackEffect * effect) GESTrackEffect * effect)
@ -906,18 +906,18 @@ ges_timeline_object_get_top_effect_position (GESTimelineObject * object,
} }
/** /**
* ges_timeline_object_set_top_effect_priority: * ges_timeline_object_set_top_effect_priority:
* @object: The origin #GESTimelineObject * @object: The origin #GESTimelineObject
* @effect: The #GESTrackEffect to move * @effect: The #GESTrackEffect to move
* @newpriority: the new position at which to move the @effect inside this * @newpriority: the new position at which to move the @effect inside this
* #GESTimelineObject * #GESTimelineObject
* *
* This is a convenience method that lets you set the priority of a top effect. * This is a convenience method that lets you set the priority of a top effect.
* *
* Returns: %TRUE if @effect was successfuly moved, %FALSE otherwise. * Returns: %TRUE if @effect was successfuly moved, %FALSE otherwise.
* *
* Since: 0.10.2 * Since: 0.10.2
*/ */
gboolean gboolean
ges_timeline_object_set_top_effect_priority (GESTimelineObject * object, ges_timeline_object_set_top_effect_priority (GESTimelineObject * object,
GESTrackEffect * effect, guint newpriority) GESTrackEffect * effect, guint newpriority)

View file

@ -197,15 +197,15 @@ ges_tl_parse_launch_effect_create_track_obj (GESTimelineObject * self,
} }
/** /**
* ges_timeline_parse_launch_effect_new: * ges_timeline_parse_launch_effect_new:
* @video_bin_description: The gst-launch like bin description of the effect * @video_bin_description: The gst-launch like bin description of the effect
* @audio_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. * Creates a new #GESTimelineParseLaunchEffect from the description of the bin.
* *
* Returns: a newly created #GESTimelineParseLaunchEffect, or %NULL if something went * Returns: (transfer full): a newly created #GESTimelineParseLaunchEffect, or
* wrong. * %NULL if something went wrong.
*/ */
GESTimelineParseLaunchEffect * GESTimelineParseLaunchEffect *
ges_timeline_parse_launch_effect_new (const gchar * video_bin_description, ges_timeline_parse_launch_effect_new (const gchar * video_bin_description,
const gchar * audio_bin_description) const gchar * audio_bin_description)

View file

@ -882,7 +882,7 @@ ges_track_object_get_element (GESTrackObject * object)
* Set the locking status of the @object in relationship to its controlling * Set the locking status of the @object in relationship to its controlling
* #GESTimelineObject. If @locked is %TRUE, then this object will move synchronously * #GESTimelineObject. If @locked is %TRUE, then this object will move synchronously
* with its controlling #GESTimelineObject. * with its controlling #GESTimelineObject.
*/ */
void void
ges_track_object_set_locked (GESTrackObject * object, gboolean locked) 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 * Gets an array of #GParamSpec* for all configurable properties of the
* children of @object. * children of @object.
* *
* Returns: (array): an array of #GParamSpec* which should be freed after use or %NULL * Returns: (transfer full) (array): an array of #GParamSpec* which should be freed after use or
* if something went wrong * %NULL if something went wrong
*/ */
GParamSpec ** GParamSpec **
ges_track_object_list_children_properties (GESTrackObject * object, ges_track_object_list_children_properties (GESTrackObject * object,

View file

@ -75,8 +75,8 @@ struct _GESTrackParseLaunchEffectClass
GType ges_track_parse_launch_effect_get_type (void); GType ges_track_parse_launch_effect_get_type (void);
GESTrackParseLaunchEffect GESTrackParseLaunchEffect*
*ges_track_parse_launch_effect_new (const gchar * bin_description); ges_track_parse_launch_effect_new (const gchar * bin_description);
G_END_DECLS G_END_DECLS
#endif /* _GES_TRACK_PARSE_LAUNCH_EFFECT */ #endif /* _GES_TRACK_PARSE_LAUNCH_EFFECT */