Added documentation for alpha parameter in Behaviour constructors.

http://bugzilla.clutter-project.org/show_bug.cgi?id=2304

Signed-off-by: Emmanuele Bassi <ebassi@linux.intel.com>
This commit is contained in:
Chris Kühl
2010-09-09 16:41:37 +02:00
committed by Emmanuele Bassi
parent 9e1cd15b48
commit d86dc377de
6 changed files with 44 additions and 12 deletions

View File

@@ -197,13 +197,17 @@ clutter_behaviour_depth_init (ClutterBehaviourDepth *depth)
/**
* clutter_behaviour_depth_new:
* @alpha: a #ClutterAlpha or %NULL
* @alpha: (allow-none): a #ClutterAlpha instance, or %NULL
* @depth_start: initial value of the depth
* @depth_end: final value of the depth
*
* Creates a new #ClutterBehaviourDepth which can be used to control
* the ClutterActor:depth property of a set of #ClutterActor<!-- -->s.
*
* If @alpha is not %NULL, the #ClutterBehaviour will take ownership
* of the #ClutterAlpha instance. In the case when @alpha is %NULL,
* it can be set later with clutter_behaviour_set_alpha().
*
* Return value: the newly created behaviour
*
* Since: 0.4