From 7c93565902be0af99526c8c1a1ab068e0892444e Mon Sep 17 00:00:00 2001
From: Emmanuele Bassi <ebassi@linux.intel.com>
Date: Fri, 16 Jan 2009 14:53:42 +0000
Subject: [PATCH] [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.
---
 clutter/clutter-alpha.c | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

diff --git a/clutter/clutter-alpha.c b/clutter/clutter-alpha.c
index fb60f79fe..78b79a275 100644
--- a/clutter/clutter-alpha.c
+++ b/clutter/clutter-alpha.c
@@ -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