docs: Description fixes for Action and Constraint
authorEmmanuele Bassi <ebassi@linux.intel.com>
Wed, 26 May 2010 13:09:24 +0000 (14:09 +0100)
committerEmmanuele Bassi <ebassi@linux.intel.com>
Wed, 26 May 2010 13:09:24 +0000 (14:09 +0100)
clutter/clutter-action.c
clutter/clutter-actor-meta.c
clutter/clutter-constraint.c

index 636ab67..c233fd1 100644 (file)
 /**
  * SECTION:clutter-action
  * @Title: ClutterAction
- * @Short_Description: Abstract class for actor actions
- * @See_Also: #ClutterEffect
+ * @Short_Description: Abstract class for event-related logic
+ * @See_Also: #ClutterConstraint
  *
- * #ClutterAction is an abstract base class for action that modify the
- * user interaction of a #ClutterActor, just like #ClutterEffect is an
- * abstract class for modifiers of the appearance of a #ClutterActor.
+ * #ClutterAction is an abstract base class for event-related actions that
+ * modify the user interaction of a #ClutterActor, just like
+ * #ClutterConstraint is an abstract class for modifiers of an actor's
+ * position or size.
  *
  * Implementations of #ClutterAction are associated to an actor and can
  * provide behavioral changes when dealing with user input - for instance
- * drag and drop capabilities, or scrolling, or panning.
+ * drag and drop capabilities, or scrolling, or panning - by using the
+ * various event-related signals provided by #ClutterActor itself.
  *
  * #ClutterAction is available since Clutter 1.4
  */
index f86e6be..7bc0905 100644 (file)
@@ -2,6 +2,7 @@
  * SECTION:clutter-actor-meta
  * @Title: ClutterActorMeta
  * @Short_Description: Base class of actor modifiers
+ * @See_Also: #ClutterAction, #ClutterConstraint
  *
  * #ClutterActorMeta is an abstract class providing a common API for
  * modifiers of #ClutterActor
index 49d30c9..46f86f7 100644 (file)
@@ -1,12 +1,16 @@
 /**
  * SECTION:clutter-constraint
  * @Title: ClutterConstraint
- * @Short_Description: A constraint on an actor's position or size
+ * @Short_Description: Abstract class for constraints on position or size
  * @See_Also: #ClutterAction
  *
  * #ClutterConstraint is a base abstract class for modifiers of a #ClutterActor
  * position or size.
  *
+ * A #ClutterConstraint sub-class should contain the logic for modifying
+ * the position or size of the #ClutterActor to which it is applied, using
+ * the various signals and properties of #ClutterActor itself.
+ *
  * #ClutterConstraint is available since Clutter 1.4
  */