From 09659ea18d0b534ba9645cbf05ca510aa702ebcf Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Wed, 26 May 2010 14:09:24 +0100 Subject: [PATCH] docs: Description fixes for Action and Constraint --- clutter/clutter-action.c | 14 ++++++++------ clutter/clutter-actor-meta.c | 1 + clutter/clutter-constraint.c | 6 +++++- 3 files changed, 14 insertions(+), 7 deletions(-) diff --git a/clutter/clutter-action.c b/clutter/clutter-action.c index 636ab67ed..c233fd141 100644 --- a/clutter/clutter-action.c +++ b/clutter/clutter-action.c @@ -25,16 +25,18 @@ /** * 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 */ diff --git a/clutter/clutter-actor-meta.c b/clutter/clutter-actor-meta.c index f86e6beea..7bc0905a2 100644 --- a/clutter/clutter-actor-meta.c +++ b/clutter/clutter-actor-meta.c @@ -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 diff --git a/clutter/clutter-constraint.c b/clutter/clutter-constraint.c index 49d30c968..46f86f7b0 100644 --- a/clutter/clutter-constraint.c +++ b/clutter/clutter-constraint.c @@ -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 */