From c096f41e70a78f7eeccafeb5bd01b9b7a5732b15 Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Fri, 16 Jan 2009 14:16:02 +0000 Subject: [PATCH] [doc] Clarify the animation mode meaning The animation mode parameters and properties are now slightly anonymous unsigned longs, so we need to clarify in the documentation that the user should either pass a ClutterAnimationMode value or the result of registering an alpha function. --- clutter/clutter-animation.c | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/clutter/clutter-animation.c b/clutter/clutter-animation.c index eb0bca1e0..5994ff38e 100644 --- a/clutter/clutter-animation.c +++ b/clutter/clutter-animation.c @@ -824,7 +824,9 @@ clutter_animation_set_mode_internal (ClutterAnimation *animation, * @animation: a #ClutterAnimation * @mode: an animation mode logical id * - * Sets the animation @mode of @animation. + * Sets the animation @mode of @animation. The animation @mode is + * a logical id, either coming from the #ClutterAnimationMode enumeration + * or the return value of clutter_alpha_register_func(). * * Since: 1.0 */ @@ -848,7 +850,8 @@ clutter_animation_set_mode (ClutterAnimation *animation, * clutter_animation_get_mode: * @animation: a #ClutterAnimation * - * Retrieves the animation mode of @animation. + * Retrieves the animation mode of @animation, as set by + * clutter_animation_set_mode(). * * Return value: the mode for the animation * @@ -1383,6 +1386,9 @@ clutter_actor_animate_with_timeline (ClutterActor *actor, * will make width and height properties of the #ClutterActor "rectangle" * grow linearly between the current value and 100 pixels, in 250 milliseconds. * + * The animation @mode is a logical id, either from the #ClutterAnimationMode + * enumeration of from clutter_alpha_register_func(). + * * All the properties specified will be animated between the current value * and the final value. If a property should be set at the beginning of * the animation but not updated during the animation, it should be prefixed