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

Miscellaneous documentation fixes

Browse Source
This commit is contained in:
Emmanuele Bassi
2010-05-19 16:10:05 +01:00
parent 52acc71161
commit 6457f66976
20 changed files with 232 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
clutter/clutter-action.c
View File

@ -23,7 +23,7 @@
*/
/**
* SECTION:ClutterAction
* SECTION:clutter-action
* @Title: ClutterAction
* @Short_Description: Abstract class for actor actions
* @See_Also: #ClutterEffect

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

@ -1,5 +1,5 @@
/**
* SECTION:ClutterActorMeta
* SECTION:clutter-actor-meta
* @Title: ClutterActorMeta
* @Short_Description: Base class of actor modifiers
*

2
clutter/clutter-align-constraint.c
View File

@ -23,7 +23,7 @@
*/
/**
* SECTION:ClutterAlignConstraint
* SECTION:clutter-align-constraint
* @Title: ClutterAlignConstraint
* @Short_Description: A constraint aligning the position of an actor
*

35
clutter/clutter-animatable.c
View File

@ -125,6 +125,19 @@ clutter_animatable_animate_property (ClutterAnimatable *animatable,
return res;
}
/**
* clutter_animatable_find_property:
* @animatable: a #ClutterAnimatable
* @animation: a #ClutterAnimation
* @property_name: the name of the animatable property to find
*
* Finds the #GParamSpec for @property_name
*
* Return value: (transfer none): The #GParamSpec for the given property
* or %NULL
*
* Since: 1.4
*/
GParamSpec *
clutter_animatable_find_property (ClutterAnimatable *animatable,
ClutterAnimation *animation,
@ -146,6 +159,17 @@ clutter_animatable_find_property (ClutterAnimatable *animatable,
property_name);
}
/**
* clutter_animatable_get_initial_state:
* @animatable: a #ClutterAnimatable
* @animation: a #ClutterAnimation
* @property_name: the name of the animatable property to retrieve
* @value: a #GValue initialized to the type of the property to retrieve
*
* Retrieves the current state of @property_name and sets @value with it
*
* Since: 1.4
*/
void
clutter_animatable_get_initial_state (ClutterAnimatable *animatable,
ClutterAnimation *animation,
@ -167,6 +191,17 @@ clutter_animatable_get_initial_state (ClutterAnimatable *animatable,
g_object_get_property (G_OBJECT (animatable), property_name, value);
}
/**
* clutter_animatable_set_final_state:
* @animatable: a #ClutterAnimatable
* @animation: a #ClutterAnimation
* @property_name: the name of the animatable property to set
* @value: the value of the animatable property to set
*
* Sets the current state of @property_name to @value
*
* Since: 1.4
*/
void
clutter_animatable_set_final_state (ClutterAnimatable *animatable,
ClutterAnimation *animation,

13
clutter/clutter-animatable.h
View File

@ -52,7 +52,14 @@ typedef struct _ClutterAnimatableIface ClutterAnimatableIface;
/**
* ClutterAnimatableIface:
* @animate_property: virtual function for animating a property
* @animate_property: virtual function for custom interpolation of a
* property
* @find_property: virtual function for retrieving the #GParamSpec of
* an animatable property
* @get_initial_state: virtual function for retrieving the initial
* state of an animatable property
* @set_final_state: virtual function for setting the state of an
* animatable property
*
* Base interface for #GObject<!-- -->s that can be animated by a
* a #ClutterAnimation.
@ -101,11 +108,11 @@ GParamSpec *clutter_animatable_find_property (ClutterAnimatable *animatable,
void clutter_animatable_get_initial_state (ClutterAnimatable *animatable,
ClutterAnimation *animation,
const gchar *property_name,
GValue *initial);
GValue *value);
void clutter_animatable_set_final_state (ClutterAnimatable *animatable,
ClutterAnimation *animation,
const gchar *property_name,
const GValue *final);
const GValue *value);
G_END_DECLS

6
clutter/clutter-animation.c
View File

@ -1989,7 +1989,7 @@ animation_create_for_actor (ClutterActor *actor)
* @actor: a #ClutterActor
* @alpha: a #ClutterAlpha
* @first_property_name: the name of a property
* @VarArgs: a %NULL terminated list of property names and
* @Varargs: a %NULL terminated list of property names and
* property values
*
* Animates the given list of properties of @actor between the current
@ -2046,7 +2046,7 @@ clutter_actor_animate_with_alpha (ClutterActor *actor,
* @mode: an animation mode logical id
* @timeline: a #ClutterTimeline
* @first_property_name: the name of a property
* @VarArgs: a %NULL terminated list of property names and
* @Varargs: a %NULL terminated list of property names and
* property values
*
* Animates the given list of properties of @actor between the current
@ -2097,7 +2097,7 @@ clutter_actor_animate_with_timeline (ClutterActor *actor,
* @mode: an animation mode logical id
* @duration: duration of the animation, in milliseconds
* @first_property_name: the name of a property
* @VarArgs: a %NULL terminated list of property names and
* @Varargs: a %NULL terminated list of property names and
* property values
*
* Animates the given list of properties of @actor between the current

2
clutter/clutter-animator.c
View File

@ -1147,7 +1147,7 @@ clutter_animator_get_duration (ClutterAnimator *animator)
* @first_mode: the id of the alpha function to use
* @first_progress: at which stage of the animation this value applies; the
* range is a normalized floating point value between 0 and 1
* @VarArgs: the value first_property_name should have for first_object
* @Varargs: the value first_property_name should have for first_object
* at first_progress, followed by more (object, property_name, mode,
* progress, value) tuples, followed by %NULL
*

2
clutter/clutter-bind-constraint.c
View File

@ -23,7 +23,7 @@
*/
/**
* SECTION:ClutterBindConstraint
* SECTION:clutter-bind-constraint
* @Title: ClutterBindConstraint
* @Short_Description: A constraint binding the position of an actor
*

2
clutter/clutter-box-layout.c
View File

@ -1419,7 +1419,7 @@ clutter_box_layout_get_vertical (ClutterBoxLayout *layout)
/**
* clutter_box_layout_set_homogeneous:
* @layout: a #ClutterBoxLayout
* @vertical: %TRUE if the layout should be homogeneous
* @homogeneous: %TRUE if the layout should be homogeneous
*
* Sets whether the size of @layout children should be
* homogeneous

12
clutter/clutter-constraint.c
View File

@ -1,3 +1,15 @@
/**
* SECTION:clutter-constraint
* @Title: ClutterConstraint
* @Short_Description: A constraint on an actor's position or size
* @See_Also: #ClutterAction
*
* #ClutterConstraint is a base abstract class for modifiers of a #ClutterActor
* position or size.
*
* #ClutterConstraint is available since Clutter 1.4
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

13
clutter/clutter-constraint.h
View File

@ -40,7 +40,6 @@ G_BEGIN_DECLS
#define CLUTTER_IS_CONSTRAINT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), CLUTTER_TYPE_CONSTRAINT))
#define CLUTTER_CONSTRAINT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), CLUTTER_TYPE_CONSTRAINT, ClutterConstraintClass))
typedef struct _ClutterConstraintPrivate ClutterConstraintPrivate;
typedef struct _ClutterConstraintClass ClutterConstraintClass;
/**
@ -55,14 +54,10 @@ struct _ClutterConstraint
{
/*< private >*/
ClutterActorMeta parent_instance;
ClutterConstraintPrivate *priv;
};
/**
* ClutterConstraintClass:
* @set_actor: virtual function, called when a constraint is applied to
* a #ClutterActor
*
* The <structname>ClutterConstraintClass</structname> structure contains
* only private data
@ -88,12 +83,12 @@ struct _ClutterConstraintClass
GType clutter_constraint_get_type (void) G_GNUC_CONST;
/* ClutterActor API */
void clutter_actor_add_constraint (ClutterActor *actor,
void clutter_actor_add_constraint (ClutterActor *self,
ClutterConstraint *constraint);
void clutter_actor_remove_constraint (ClutterActor *actor,
void clutter_actor_remove_constraint (ClutterActor *self,
ClutterConstraint *constraint);
GList *clutter_actor_get_constraints (ClutterActor *actor);
void clutter_actor_clear_constraints (ClutterActor *actor);
GList *clutter_actor_get_constraints (ClutterActor *self);
void clutter_actor_clear_constraints (ClutterActor *self);
G_END_DECLS

2
clutter/clutter-drag-action.c
View File

@ -23,7 +23,7 @@
*/
/**
* SECTION:ClutterDragAction
* SECTION:clutter-drag-action
* @Title: ClutterDragAction
* @Short_Description: Action enabling dragging on actors
*

2
clutter/clutter-event.h
View File

@ -417,7 +417,6 @@ struct _ClutterStageStateEvent
/**
* ClutterEvent:
* @type: event type
*
* Generic event wrapper.
*
@ -425,6 +424,7 @@ struct _ClutterStageStateEvent
*/
union _ClutterEvent
{
/*< private >*/
ClutterEventType type;
ClutterAnyEvent any;

1
clutter/clutter-media.h
View File

@ -65,6 +65,7 @@ struct _ClutterMediaIface
/*< private >*/
GTypeInterface base_iface;
/*< public >*/
/* signals */
void (* eos) (ClutterMedia *media);
void (* error) (ClutterMedia *media,

4
clutter/clutter-stage-manager.h
View File

@ -53,10 +53,6 @@ typedef struct _ClutterStageManagerClass ClutterStageManagerClass;
/**
* ClutterStageManagerClass:
* @stage_added: class handler for the #ClutterStageManager::stage-added
* signal
* @stage_removed: class handler for the #ClutterStageManager::stage-removed
* signal
*
* The #ClutterStageManagerClass structure contains only private data
* and should be accessed using the provided API