isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2025-03-25 04:33:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: gtk-doc fixes for Animator

Browse Source 
Fix the syntax for:

  → enumeration values
  → return values
  → @since tags

Also, fix the introspection annotations.
This commit is contained in:
Emmanuele Bassi 2010-02-25 22:50:38 +00:00
parent 9db135c4ef
commit 63279f827e
1 changed files with 27 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
clutter/clutter-animator.c
View File

@ -195,9 +195,11 @@ G_DEFINE_TYPE_WITH_CODE (ClutterAnimator,
/** /**
* clutter_animator_new: * clutter_animator_new:
* *
* Create a new #ClutterAnimator instance. * Creates a new #ClutterAnimator instance
* *
* Returns: a new #ClutterAnimator. * Return value: a new #ClutterAnimator.
*
* Since: 1.2
*/ */
ClutterAnimator * ClutterAnimator *
clutter_animator_new (void) clutter_animator_new (void)
@ -832,9 +834,9 @@ animation_animator_started (ClutterTimeline *timeline,
* If the property is an ease-in property, the current value of the property * If the property is an ease-in property, the current value of the property
* on the object will be used as the starting point for computation. * on the object will be used as the starting point for computation.
* *
* Returns: TRUE if the computation yields has a value, otherwise (when an * Return value: %TRUE if the computation yields has a value, otherwise (when
* error occurs or the progress is before any of the keys FALSE is returned * an error occurs or the progress is before any of the keys) %FALSE is
* and value is left untouched. * returned and the #GValue is left untouched
* *
* Since: 1.2 * Since: 1.2
*/ */
@ -988,16 +990,20 @@ clutter_animator_compute_value (ClutterAnimator *animator,
clutter_interval_compute_value (interval, clutter_interval_compute_value (interval,
sub_progress, sub_progress,
value); value);
g_object_ref_sink (interval); g_object_ref_sink (interval);
g_object_unref (interval); g_object_unref (interval);
g_object_ref_sink (alpha); g_object_ref_sink (alpha);
g_object_unref (alpha); g_object_unref (alpha);
return TRUE; return TRUE;
} }
} }
/* We're at, or past the end, use the last value */ /* We're at, or past the end, use the last value */
g_value_copy (&next->value, value); g_value_copy (&next->value, value);
return TRUE; return TRUE;
} }
@ -1052,7 +1058,9 @@ clutter_animator_set_timeline (ClutterAnimator *animator,
* *
* Get the timeline hooked up for driving the #ClutterAnimator * Get the timeline hooked up for driving the #ClutterAnimator
* *
* Return value: the #ClutterTimeline that drives the animator. * Return value: (transfer none): the #ClutterTimeline that drives the animator
*
* Since: 1.2
*/ */
ClutterTimeline * ClutterTimeline *
clutter_animator_get_timeline (ClutterAnimator *animator) clutter_animator_get_timeline (ClutterAnimator *animator)
@ -1069,6 +1077,8 @@ clutter_animator_get_timeline (ClutterAnimator *animator)
* and starts the animators current timeline. * and starts the animators current timeline.
* *
* Return value: the #ClutterTimeline that drives the animator. * Return value: the #ClutterTimeline that drives the animator.
*
* Since: 1.2
*/ */
ClutterTimeline * ClutterTimeline *
clutter_animator_run (ClutterAnimator *animator) clutter_animator_run (ClutterAnimator *animator)
@ -1304,9 +1314,11 @@ clutter_animator_set_key (ClutterAnimator *animator,
/** /**
* clutter_animator_get_keys: * clutter_animator_get_keys:
* @animator: a #ClutterAnimator instance * @animator: a #ClutterAnimator instance
* @object: a #GObject to search for or NULL for all * @object: (allow-none): a #GObject to search for, or %NULL for all objects
* @property_name: a specific property name to query for or NULL for all * @property_name: (allow-none): a specific property name to query for,
* @progress: a specific progress to search for or a negative value for all * or %NULL for all properties
* @progress: a specific progress to search for, or a negative value for all
* progresses
* *
* Returns a list of pointers to opaque structures with accessor functions * Returns a list of pointers to opaque structures with accessor functions
* that describe the keys added to an animator. * that describe the keys added to an animator.
@ -1320,7 +1332,7 @@ clutter_animator_set_key (ClutterAnimator *animator,
*/ */
GList * GList *
clutter_animator_get_keys (ClutterAnimator *animator, clutter_animator_get_keys (ClutterAnimator *animator,
GObject *object,/* or NULL for all */ GObject *object,
const gchar *property_name, const gchar *property_name,
gdouble progress) gdouble progress)
{ {
@ -1328,6 +1340,7 @@ clutter_animator_get_keys (ClutterAnimator *animator,
GList *k; GList *k;
g_return_val_if_fail (CLUTTER_IS_ANIMATOR (animator), NULL); g_return_val_if_fail (CLUTTER_IS_ANIMATOR (animator), NULL);
g_return_val_if_fail (object == NULL || G_IS_OBJECT (object), NULL);
property_name = g_intern_string (property_name); property_name = g_intern_string (property_name);
@ -1876,9 +1889,10 @@ clutter_animator_property_get_interpolation (ClutterAnimator *animator,
* @property_name: the name of a property on object * @property_name: the name of a property on object
* @interpolation: the #ClutterInterpolation to use * @interpolation: the #ClutterInterpolation to use
* *
* Set the interpolation method to use, CLUTTER_INTERPOLATION_LINEAR causes the * Set the interpolation method to use, %CLUTTER_INTERPOLATION_LINEAR causes
* values to linearly change between the values, CLUTTER_INTERPOLATION_CUBIC * the values to linearly change between the values, and
* causes the values to smoothly change between the values. * %CLUTTER_INTERPOLATION_CUBIC causes the values to smoothly change between
* the values.
* *
* Since: 1.2 * Since: 1.2
*/ */