mirror of
https://github.com/brl/mutter.git
synced 2024-11-26 01:50:42 -05:00
Miscellaneous documentation fixes
This commit is contained in:
parent
52acc71161
commit
6457f66976
@ -23,7 +23,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* SECTION:ClutterAction
|
||||
* SECTION:clutter-action
|
||||
* @Title: ClutterAction
|
||||
* @Short_Description: Abstract class for actor actions
|
||||
* @See_Also: #ClutterEffect
|
||||
|
@ -1,5 +1,5 @@
|
||||
/**
|
||||
* SECTION:ClutterActorMeta
|
||||
* SECTION:clutter-actor-meta
|
||||
* @Title: ClutterActorMeta
|
||||
* @Short_Description: Base class of actor modifiers
|
||||
*
|
||||
|
@ -23,7 +23,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* SECTION:ClutterAlignConstraint
|
||||
* SECTION:clutter-align-constraint
|
||||
* @Title: ClutterAlignConstraint
|
||||
* @Short_Description: A constraint aligning the position of an actor
|
||||
*
|
||||
|
@ -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,
|
||||
|
@ -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
|
||||
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
*
|
||||
|
@ -23,7 +23,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* SECTION:ClutterBindConstraint
|
||||
* SECTION:clutter-bind-constraint
|
||||
* @Title: ClutterBindConstraint
|
||||
* @Short_Description: A constraint binding the position of an actor
|
||||
*
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
||||
|
@ -23,7 +23,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* SECTION:ClutterDragAction
|
||||
* SECTION:clutter-drag-action
|
||||
* @Title: ClutterDragAction
|
||||
* @Short_Description: Action enabling dragging on actors
|
||||
*
|
||||
|
@ -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;
|
||||
|
@ -65,6 +65,7 @@ struct _ClutterMediaIface
|
||||
/*< private >*/
|
||||
GTypeInterface base_iface;
|
||||
|
||||
/*< public >*/
|
||||
/* signals */
|
||||
void (* eos) (ClutterMedia *media);
|
||||
void (* error) (ClutterMedia *media,
|
||||
|
@ -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
|
||||
|
@ -766,8 +766,8 @@ PKG_CHECK_MODULES(CLUTTER_DEPS, [$CLUTTER_REQUIRES])
|
||||
|
||||
AC_SUBST(CLUTTER_REQUIRES)
|
||||
|
||||
CLUTTER_CFLAGS="$SDL_CFLAGS $EGL_CFLAGS $GLX_CFLAGS $OSX_CFLAGS $WIN32_CFLAGS $CLUTTER_DEPS_CFLAGS $CLUTTER_PROFILE_CFLAGS"
|
||||
CLUTTER_LIBS="$SDL_LIBS $EGL_LIBS $X11_LIBS $GLX_LIBS $OSX_LIBS $WIN32_LIBS $CLUTTER_DEPS_LIBS $CLUTTER_PROFILE_LDFLAGS"
|
||||
CLUTTER_CFLAGS="$EGL_CFLAGS $GLX_CFLAGS $OSX_CFLAGS $WIN32_CFLAGS $CLUTTER_DEPS_CFLAGS $CLUTTER_PROFILE_CFLAGS"
|
||||
CLUTTER_LIBS="$EGL_LIBS $X11_LIBS $GLX_LIBS $OSX_LIBS $WIN32_LIBS $CLUTTER_DEPS_LIBS $CLUTTER_PROFILE_LDFLAGS"
|
||||
|
||||
AC_SUBST(CLUTTER_CFLAGS)
|
||||
AC_SUBST(CLUTTER_LIBS)
|
||||
@ -778,7 +778,7 @@ GOBJECT_INTROSPECTION_CHECK([0.6.7])
|
||||
|
||||
dnl === GTK Doc check =========================================================
|
||||
|
||||
GTK_DOC_CHECK([1.13])
|
||||
GTK_DOC_CHECK([1.13], [--flavour no-tmpl])
|
||||
|
||||
# we don't want to build the documentation from a Git clone unless we
|
||||
# explicitly tell configure to do so; this allows avoiding to recurse into
|
||||
|
@ -64,6 +64,7 @@ CFILE_GLOB=$(top_srcdir)/clutter/*.c \
|
||||
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
|
||||
IGNORE_HFILES=\
|
||||
clutter.h \
|
||||
clutter-actor-meta-private.h \
|
||||
clutter-bezier.h \
|
||||
clutter-debug.h \
|
||||
clutter-deprecated.h \
|
||||
|
@ -60,6 +60,7 @@
|
||||
<xi:include href="xml/clutter-media.xml"/>
|
||||
<xi:include href="xml/clutter-layout-manager.xml"/>
|
||||
<xi:include href="xml/clutter-layout-meta.xml"/>
|
||||
<xi:include href="xml/clutter-actor-meta.xml"/>
|
||||
</chapter>
|
||||
|
||||
<chapter>
|
||||
@ -88,6 +89,16 @@
|
||||
<xi:include href="xml/clutter-box-layout.xml"/>
|
||||
</chapter>
|
||||
|
||||
<chapter>
|
||||
<title>Actor Modifiers</title>
|
||||
|
||||
<xi:include href="xml/clutter-action.xml"/>
|
||||
<xi:include href="xml/clutter-constraint.xml"/>
|
||||
<xi:include href="xml/clutter-drag-action.xml"/>
|
||||
<xi:include href="xml/clutter-bind-constraint.xml"/>
|
||||
<xi:include href="xml/clutter-align-constraint.xml"/>
|
||||
</chapter>
|
||||
|
||||
</part>
|
||||
|
||||
<part id="clutteranimation">
|
||||
|
@ -274,7 +274,6 @@ CLUTTER_ACTOR_IS_REACTIVE
|
||||
<SUBSECTION>
|
||||
ClutterActorFlags
|
||||
ClutterRequestMode
|
||||
ClutterGeometry
|
||||
CLUTTER_CALLBACK
|
||||
ClutterCallback
|
||||
ClutterActor
|
||||
@ -409,6 +408,16 @@ clutter_actor_set_text_direction
|
||||
clutter_actor_get_text_direction
|
||||
clutter_actor_has_pointer
|
||||
|
||||
<SUBSECTION>
|
||||
clutter_actor_add_action
|
||||
clutter_actor_remove_action
|
||||
clutter_actor_get_actions
|
||||
clutter_actor_clear_actions
|
||||
clutter_actor_add_constraint
|
||||
clutter_actor_remove_constraint
|
||||
clutter_actor_get_constraints
|
||||
clutter_actor_clear_constraints
|
||||
|
||||
<SUBSECTION>
|
||||
ClutterActorBox
|
||||
clutter_actor_box_new
|
||||
@ -434,6 +443,10 @@ clutter_vertex_copy
|
||||
clutter_vertex_free
|
||||
clutter_vertex_equal
|
||||
|
||||
<SUBSECTION>
|
||||
ClutterGeometry
|
||||
clutter_geometry_union
|
||||
|
||||
<SUBSECTION Standard>
|
||||
CLUTTER_TYPE_GEOMETRY
|
||||
CLUTTER_TYPE_ACTOR_BOX
|
||||
@ -444,7 +457,9 @@ CLUTTER_TYPE_ACTOR
|
||||
CLUTTER_ACTOR_CLASS
|
||||
CLUTTER_IS_ACTOR_CLASS
|
||||
CLUTTER_ACTOR_GET_CLASS
|
||||
|
||||
<SUBSECTION Private>
|
||||
ClutterRedrawFlags
|
||||
ClutterActorPrivate
|
||||
clutter_actor_get_type
|
||||
clutter_actor_box_get_type
|
||||
@ -1712,6 +1727,9 @@ clutter_text_get_type
|
||||
ClutterAnimatable
|
||||
ClutterAnimatableIface
|
||||
clutter_animatable_animate_property
|
||||
clutter_animatable_find_property
|
||||
clutter_animatable_get_initial_state
|
||||
clutter_animatable_set_final_state
|
||||
|
||||
<SUBSECTION Standard>
|
||||
CLUTTER_TYPE_ANIMATABLE
|
||||
@ -1993,6 +2011,8 @@ clutter_box_layout_set_spacing
|
||||
clutter_box_layout_get_spacing
|
||||
clutter_box_layout_set_vertical
|
||||
clutter_box_layout_get_vertical
|
||||
clutter_box_layout_set_homogeneous
|
||||
clutter_box_layout_get_homogeneous
|
||||
|
||||
<SUBSECTION>
|
||||
clutter_box_layout_pack
|
||||
@ -2075,3 +2095,120 @@ clutter_animator_get_type
|
||||
clutter_animator_key_get_type
|
||||
ClutterAnimatorPrivate
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>clutter-actor-meta</FILE>
|
||||
<TITLE>ClutterActorMeta</TITLE>
|
||||
ClutterActorMeta
|
||||
ClutterActorMetaClass
|
||||
clutter_actor_meta_set_name
|
||||
clutter_actor_meta_get_name
|
||||
clutter_actor_meta_set_enabled
|
||||
clutter_actor_meta_get_enabled
|
||||
|
||||
<SUBSECTION>
|
||||
clutter_actor_meta_get_actor
|
||||
|
||||
<SUBSECTION Standard>
|
||||
CLUTTER_TYPE_ACTOR_META
|
||||
CLUTTER_ACTOR_META
|
||||
CLUTTER_ACTOR_META_CLASS
|
||||
CLUTTER_IS_ACTOR_META
|
||||
CLUTTER_IS_ACTOR_META_CLASS
|
||||
CLUTTER_ACTOR_META_GET_CLASS
|
||||
clutter_actor_meta_get_type
|
||||
|
||||
<SUBSECTION Private>
|
||||
ClutterActorMetaPrivate
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>clutter-action</FILE>
|
||||
<TITLE>ClutterAction</TITLE>
|
||||
ClutterAction
|
||||
ClutterActionClass
|
||||
|
||||
<SUBSECTION Standard>
|
||||
CLUTTER_TYPE_ACTION
|
||||
CLUTTER_ACTION
|
||||
CLUTTER_ACTION_CLASS
|
||||
CLUTTER_IS_ACTION
|
||||
CLUTTER_IS_ACTION_CLASS
|
||||
CLUTTER_ACTION_GET_CLASS
|
||||
clutter_action_get_type
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>clutter-constraint</FILE>
|
||||
<TITLE>ClutterConstraint</TITLE>
|
||||
ClutterConstraint
|
||||
ClutterConstraintClass
|
||||
|
||||
<SUBSECTION Standard>
|
||||
CLUTTER_TYPE_CONSTRAINT
|
||||
CLUTTER_CONSTRAINT
|
||||
CLUTTER_CONSTRAINT_CLASS
|
||||
CLUTTER_IS_CONSTRAINT
|
||||
CLUTTER_IS_CONSTRAINT_CLASS
|
||||
CLUTTER_CONSTRAINT_GET_CLASS
|
||||
clutter_constraint_get_type
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>clutter-drag-action</FILE>
|
||||
<TITLE>ClutterDragAction</TITLE>
|
||||
ClutterDragAction
|
||||
ClutterDragActionClass
|
||||
clutter_drag_action_new
|
||||
clutter_drag_action_set_drag_threshold
|
||||
clutter_drag_action_get_drag_threshold
|
||||
clutter_drag_action_set_drag_handle
|
||||
clutter_drag_action_get_drag_handle
|
||||
ClutterDragAxis
|
||||
clutter_drag_action_set_drag_axis
|
||||
clutter_drag_action_get_drag_axis
|
||||
|
||||
<SUBSECTION>
|
||||
clutter_drag_action_get_press_coords
|
||||
clutter_drag_action_get_motion_coords
|
||||
|
||||
<SUBSECTION Standard>
|
||||
CLUTTER_TYPE_DRAG_ACTION
|
||||
CLUTTER_DRAG_ACTION
|
||||
CLUTTER_DRAG_ACTION_CLASS
|
||||
CLUTTER_IS_DRAG_ACTION
|
||||
CLUTTER_IS_DRAG_ACTION_CLASS
|
||||
CLUTTER_DRAG_ACTION_GET_CLASS
|
||||
clutter_drag_action_get_type
|
||||
|
||||
<SUBSECTION Private>
|
||||
ClutterDragActionPrivate
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>clutter-bind-constraint</FILE>
|
||||
<TITLE>ClutterBindConstraint</TITLE>
|
||||
ClutterBindConstraint
|
||||
ClutterBindCoordinate
|
||||
clutter_bind_constraint_new
|
||||
|
||||
<SUBSECTION Standard>
|
||||
CLUTTER_TYPE_BIND_CONSTRAINT
|
||||
CLUTTER_BIND_CONSTRAINT
|
||||
CLUTTER_IS_BIND_CONSTRAINT
|
||||
clutter_bind_constraint_get_type
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>clutter-align-constraint</FILE>
|
||||
<TITLE>ClutterAlignConstraint</TITLE>
|
||||
ClutterAlignConstraint
|
||||
ClutterAlignAxis
|
||||
clutter_align_constraint_new
|
||||
|
||||
<SUBSECTION Standard>
|
||||
CLUTTER_TYPE_ALIGN_CONSTRAINT
|
||||
CLUTTER_ALIGN_CONSTRAINT
|
||||
CLUTTER_IS_ALIGN_CONSTRAINT
|
||||
clutter_align_constraint_get_type
|
||||
</SECTION>
|
||||
|
@ -43,3 +43,9 @@ clutter_box_layout_get_type
|
||||
clutter_input_device_get_type
|
||||
clutter_device_manager_get_type
|
||||
clutter_animator_get_type
|
||||
clutter_actor_meta_get_type
|
||||
clutter_action_get_type
|
||||
clutter_drag_action_get_type
|
||||
clutter_constraint_get_type
|
||||
clutter_bind_constraint_get_type
|
||||
clutter_align_constraint_get_type
|
||||
|
Loading…
Reference in New Issue
Block a user