[clutter] docs: Inline test-constraints.c inside BindConstraint's description



commit 79e152b7a0f1c6646f485dd17de4935c51778b86
Author: Emmanuele Bassi <ebassi linux intel com>
Date:   Fri Sep 2 15:48:27 2011 +0100

    docs: Inline test-constraints.c inside BindConstraint's description

 clutter/clutter-bind-constraint.c |   15 +++++++++++++++
 1 files changed, 15 insertions(+), 0 deletions(-)
---
diff --git a/clutter/clutter-bind-constraint.c b/clutter/clutter-bind-constraint.c
index a234721..fc76902 100644
--- a/clutter/clutter-bind-constraint.c
+++ b/clutter/clutter-bind-constraint.c
@@ -77,6 +77,21 @@
  *                        NULL);
  * ]|
  *
+ * <example id="bind-constraint-example">
+ *   <title>Animating the offset property of ClutterBindConstraint</title>
+ *   <programlisting>
+ * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; parse="text" href="../../../../tests/interactive/test-constraints.c">
+ *   <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
+ * </xi:include>
+ *   </programlisting>
+ *   <para>The example above creates eight rectangles and binds them to a
+ *   rectangle positioned in the center of the stage; when the user presses
+ *   the center rectangle, the #ClutterBindConstraint:offset property is
+ *   animated through the clutter_actor_animate() function to lay out the
+ *   eight rectangles around the center one. Pressing one of the outer
+ *   rectangles will animate the offset back to 0.</para>
+ * </example>
+ *
  * #ClutterBindConstraint is available since Clutter 1.4
  */
 



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]