From cb7d2943eafd65a2526f7da0f9e5d8bf1a176f32 Mon Sep 17 00:00:00 2001
From: Chris Lord <chris@linux.intel.com>
Date: Fri, 22 Oct 2010 17:41:06 +0100
Subject: [PATCH] state: Correct the documentation

Correct the argument order and replace all occurrences of
clutter_state_change() with the appropriate clutter_state_set_state() or
clutter_state_warp_to_state().
---
 clutter/clutter-state.c | 21 +++++++++++----------
 1 file changed, 11 insertions(+), 10 deletions(-)

diff --git a/clutter/clutter-state.c b/clutter/clutter-state.c
index bb355daa0..b722281d7 100644
--- a/clutter/clutter-state.c
+++ b/clutter/clutter-state.c
@@ -719,9 +719,9 @@ get_property_from_object (GObject     *gobject,
  *
  * |[
  *   clutter_state_set (state, NULL, "hover",
- *                      button, "opacity", 255, CLUTTER_LINEAR,
- *                      button, "scale-x", 1.2, CLUTTER_EASE_OUT_CUBIC,
- *                      button, "scale-y", 1.2, CLUTTER_EASE_OUT_CUBIC,
+ *                      button, "opacity", CLUTTER_LINEAR, 255,
+ *                      button, "scale-x", CLUTTER_EASE_OUT_CUBIC, 1.2,
+ *                      button, "scale-y", CLUTTER_EASE_OUT_CUBIC, 1.2,
  *                      NULL);
  * ]|
  *
@@ -732,10 +732,10 @@ get_property_from_object (GObject     *gobject,
  * mode, and the #ClutterActor:scale-x and #ClutterActor:scale-y properties
  * animated to a value of 1.2 using %CLUTTER_EASE_OUT_CUBIC as the animation
  * mode. To change the state (and start the transition) you can use the
- * clutter_state_change() function:
+ * clutter_state_set_state() function:
  *
  * |[
- *   clutter_state_change (state, "hover", TRUE);
+ *   clutter_state_set_state (state, "hover");
  * ]|
  *
  * If a given object, state_name, property tuple already exist in the
@@ -749,8 +749,8 @@ get_property_from_object (GObject     *gobject,
  *
  * |[
  *   clutter_state_set (state, "hover", "toggled",
- *                      button, "delayed::scale-x", 1.0, 0.2, 0.2,
- *                      button, "delayed::scale-y", 1.0, 0.2, 0.2,
+ *                      button, "delayed::scale-x", CLUTTER_LINEAR, 1.0, 0.2, 0.2,
+ *                      button, "delayed::scale-y", CLUTTER_LINEAR, 1.0, 0.2, 0.2,
  *                      NULL);
  * ]|
  *
@@ -1242,7 +1242,8 @@ clutter_state_class_init (ClutterStateClass *klass)
    * @state: the #ClutterState that emitted the signal
    *
    * The ::completed signal is emitted when a #ClutterState reaches
-   * the target state specified by clutter_state_change()
+   * the target state specified by clutter_state_set_state() or
+   * clutter_state_warp_to_state().
    *
    * Since: 1.4
    */
@@ -1260,8 +1261,8 @@ clutter_state_class_init (ClutterStateClass *klass)
    *
    * The currently set target state, setting it causes the
    * state machine to transition to the new state, use
-   * clutter_state_change() with a final FALSE argument to
-   * change state without a transition.
+   * clutter_state_warp_to_state() to change state without
+   * a transition.
    */
   pspec = g_param_spec_string ("state",
                                P_("State"),