From 6575f25e3258970f68ff4b3391e9c55843be1671 Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Tue, 21 Feb 2012 15:14:26 +0000 Subject: [PATCH] docs: "Soft" deprecation of ClutterAlpha We cannot deprecate ClutterAlpha yet. We cannot also implement ClutterAlpha in terms of ClutterTimeline, because multiple Alpha instances can be attached to the same Timeline. So we can start with a "soft" deprecation: just a warning in the documentation stating that ClutterAlpha will be deprecated, and removed, in the future, and that newly-written code should use ClutterTimeline instead. --- clutter/clutter-alpha.c | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/clutter/clutter-alpha.c b/clutter/clutter-alpha.c index c4d663336..6e9319bbc 100644 --- a/clutter/clutter-alpha.c +++ b/clutter/clutter-alpha.c @@ -32,6 +32,12 @@ * #ClutterAlpha is a class for calculating an floating point value * dependent only on the position of a #ClutterTimeline. * + * For newly written code, it is recommended to use the + * #ClutterTimeline:progress-mode property of #ClutterTimeline, or the + * clutter_timeline_set_progress_func() function instead of #ClutterAlpha. + * The #ClutterAlpha class will be deprecated in the future, and will not + * be available any more in the next major version of Clutter. + * * A #ClutterAlpha binds a #ClutterTimeline to a progress function which * translates the time T into an adimensional factor alpha. The factor can * then be used to drive a #ClutterBehaviour, which will translate the