brl/mutter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Description fixes for Action and Constraint

Browse Source
This commit is contained in:
Emmanuele Bassi 2010-05-26 14:09:24 +01:00
parent 9510cbbad2
commit 09659ea18d
3 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
clutter/clutter-action.c
View File

@ -25,16 +25,18 @@
/** /**
* SECTION:clutter-action * SECTION:clutter-action
* @Title: ClutterAction * @Title: ClutterAction
* @Short_Description: Abstract class for actor actions * @Short_Description: Abstract class for event-related logic
* @See_Also: #ClutterEffect * @See_Also: #ClutterConstraint
* *
* #ClutterAction is an abstract base class for action that modify the * #ClutterAction is an abstract base class for event-related actions that
* user interaction of a #ClutterActor, just like #ClutterEffect is an * modify the user interaction of a #ClutterActor, just like
* abstract class for modifiers of the appearance of a #ClutterActor. * #ClutterConstraint is an abstract class for modifiers of an actor's
* position or size.
* *
* Implementations of #ClutterAction are associated to an actor and can * Implementations of #ClutterAction are associated to an actor and can
* provide behavioral changes when dealing with user input - for instance * 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 * #ClutterAction is available since Clutter 1.4
*/ */

1
clutter/clutter-actor-meta.c
View File

@ -2,6 +2,7 @@
* SECTION:clutter-actor-meta * SECTION:clutter-actor-meta
* @Title: ClutterActorMeta * @Title: ClutterActorMeta
* @Short_Description: Base class of actor modifiers * @Short_Description: Base class of actor modifiers
* @See_Also: #ClutterAction, #ClutterConstraint
* *
* #ClutterActorMeta is an abstract class providing a common API for * #ClutterActorMeta is an abstract class providing a common API for
* modifiers of #ClutterActor * modifiers of #ClutterActor

6
clutter/clutter-constraint.c
View File

@ -1,12 +1,16 @@
/** /**
* SECTION:clutter-constraint * SECTION:clutter-constraint
* @Title: ClutterConstraint * @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 * @See_Also: #ClutterAction
* *
* #ClutterConstraint is a base abstract class for modifiers of a #ClutterActor * #ClutterConstraint is a base abstract class for modifiers of a #ClutterActor
* position or size. * 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 * #ClutterConstraint is available since Clutter 1.4
*/ */