[docs] Clarify what API registers a global alpha function

Both clutter_alpha_new_with_func() and clutter_alpha_set_func()
will not register a global alpha function, so we need to update
the documentation to explicitly say so.
This commit is contained in:
Emmanuele Bassi 2009-01-16 14:53:42 +00:00
parent c096f41e70
commit 7c93565902

View File

@ -325,9 +325,8 @@ clutter_alpha_get_alpha (ClutterAlpha *alpha)
* @alpha: A #ClutterAlpha
* @closure: A #GClosure
*
* Sets the #GClosure used to compute
* the alpha value at each frame of the #ClutterTimeline
* bound to @alpha.
* Sets the #GClosure used to compute the alpha value at each
* frame of the #ClutterTimeline bound to @alpha.
*
* Since: 0.8
*/
@ -370,6 +369,8 @@ clutter_alpha_set_closure (ClutterAlpha *alpha,
* the alpha value at each frame of the #ClutterTimeline
* bound to @alpha.
*
* This function will not register @func as a global alpha function.
*
* Since: 0.2
*/
void
@ -483,7 +484,7 @@ clutter_alpha_new (void)
*
* Return Value: the newly created #ClutterAlpha
*
* Since: 0.2
* Since: 1.0
*/
ClutterAlpha *
clutter_alpha_new_full (ClutterTimeline *timeline,
@ -508,6 +509,10 @@ clutter_alpha_new_full (ClutterTimeline *timeline,
* Creates a new #ClutterAlpha instances and sets the timeline
* and the alpha function.
*
* This function will not register @func as a global alpha function.
*
* See also clutter_alpha_set_timeline() and clutter_alpha_set_func().
*
* Return value: the newly created #ClutterAlpha
*
* Since: 1.0