diff --git a/clutter/clutter-alpha.c b/clutter/clutter-alpha.c index bd8b048fa..f525b5925 100644 --- a/clutter/clutter-alpha.c +++ b/clutter/clutter-alpha.c @@ -603,7 +603,7 @@ clutter_sine_func (ClutterAlpha *alpha, * @alpha: a #ClutterAlpha * @dummy: unused argument * - * Convenience alpha function for a sine wave over interval <0, pi/2>. + * Convenience alpha function for a sine wave over interval [0, pi / 2]. * You can use this function as the alpha function for * clutter_alpha_set_func(). * @@ -637,7 +637,7 @@ clutter_sine_inc_func (ClutterAlpha *alpha, * @alpha: a #ClutterAlpha * @dummy: unused argument * - * Convenience alpha function for a sine wave over interval . + * Convenience alpha function for a sine wave over interval [pi / 2, pi]. * You can use this function as the alpha function for * clutter_alpha_set_func(). * @@ -671,7 +671,7 @@ clutter_sine_dec_func (ClutterAlpha *alpha, * @alpha: a #ClutterAlpha * @dummy: unused argument * - * Convenience alpha function for a sine wave over interval <0, pi>. + * Convenience alpha function for a sine wave over interval [0, pi]. * You can use this function as the alpha function for * clutter_alpha_set_func(). * @@ -798,8 +798,8 @@ clutter_smoothstep_get_type (void) * Since: 0.4 */ guint32 -clutter_smoothstep_func (ClutterAlpha * alpha, - gpointer * data) +clutter_smoothstep_func (ClutterAlpha *alpha, + gpointer *data) { ClutterSmoothstep * smoothstep = data; ClutterTimeline * timeline; diff --git a/clutter/clutter-behaviour-bspline.c b/clutter/clutter-behaviour-bspline.c index 6ba19e04d..0ab7d3107 100644 --- a/clutter/clutter-behaviour-bspline.c +++ b/clutter/clutter-behaviour-bspline.c @@ -919,20 +919,21 @@ clutter_behaviour_bspline_join (ClutterBehaviourBspline * bs1, /** * clutter_behaviour_bspline_split: - * @bs: a #ClutterBehaviourBspline - * @offset: an offset of the control point at which to split the spline. - * - * Return: new ClutterBehaviourBspline. + * @bs: a #ClutterBehaviourBspline + * @offset: an offset of the control point at which to split the spline. * * Splits a bezier spline into two at the control point at offset; if the * control point at offset is not one of the on-curve bezier points, the * bspline will be split at the nearest on-curve point before the offset. * The original bspline is shortened appropriately. * + * Return value: new ClutterBehaviourBspline. + * * Since: 0.4 */ ClutterBehaviour * -clutter_behaviour_bspline_split (ClutterBehaviourBspline * bs, guint offset) +clutter_behaviour_bspline_split (ClutterBehaviourBspline *bs, + guint offset) { ClutterBehaviourBspline * bs2 = NULL; ClutterAlpha * alpha; diff --git a/clutter/clutter-behaviour-ellipse.c b/clutter/clutter-behaviour-ellipse.c index 02b3bc278..df6d08176 100644 --- a/clutter/clutter-behaviour-ellipse.c +++ b/clutter/clutter-behaviour-ellipse.c @@ -502,6 +502,8 @@ clutter_behaviour_ellipse_set_width (ClutterBehaviourEllipse * self, * @self: a #ClutterBehaviourEllipse * * Gets the width of the elliptical path. + * + * Return: the width of the path * * Since: 0.4 */ @@ -538,6 +540,8 @@ clutter_behaviour_ellipse_set_height (ClutterBehaviourEllipse * self, * @self: a #ClutterBehaviourEllipse * * Gets the height of the elliptical path. + * + * Return value: the height of the path * * Since: 0.4 */ @@ -574,7 +578,9 @@ clutter_behaviour_ellipse_set_angle_begin (ClutterBehaviourEllipse * self, * clutter_behaviour_ellipse_get_angle_begin * @self: a #ClutterBehaviourEllipse * - * Gets the at which movements begins. + * Gets the angle at which movements begins. + * + * Return value: a #ClutterAngle * * Since: 0.4 */ @@ -612,6 +618,8 @@ clutter_behaviour_ellipse_set_angle_end (ClutterBehaviourEllipse * self, * @self: a #ClutterBehaviourEllipse * * Gets the at which movements ends. + * + * Return value: a #ClutterAngle * * Since: 0.4 */ @@ -649,6 +657,8 @@ clutter_behaviour_ellipse_set_angle_tilt (ClutterBehaviourEllipse * self, * @self: a #ClutterBehaviourEllipse * * Gets the tilt of the ellipse around the center. + * + * Return value: a #ClutterAngle * * Since: 0.4 */ diff --git a/doc/reference/ChangeLog b/doc/reference/ChangeLog index 02050dbe9..61a1a114e 100644 --- a/doc/reference/ChangeLog +++ b/doc/reference/ChangeLog @@ -1,3 +1,11 @@ +2007-05-17 Emmanuele Bassi + + * Makefile.am: Ignore the sdl backend. + + * clutter-sections.txt: Add undocumented symbols. + + * clutter-docs.sgml: Add ClutterLayout section to the documentation. + 2007-05-16 Emmanuele Bassi * Makefile.am: Use the newly added clutter_base_init() function diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am index 5e3ba82d2..e1f39bede 100644 --- a/doc/reference/Makefile.am +++ b/doc/reference/Makefile.am @@ -59,6 +59,7 @@ IGNORE_HFILES=\ cogl \ egl \ glx \ + sdl \ pango EXTRA_HFILES=\ diff --git a/doc/reference/clutter-sections.txt b/doc/reference/clutter-sections.txt index b3d5dc501..f79eda137 100644 --- a/doc/reference/clutter-sections.txt +++ b/doc/reference/clutter-sections.txt @@ -1,5 +1,6 @@
clutter-media +ClutterMedia ClutterMedia ClutterMediaInterface clutter_media_set_uri @@ -69,6 +70,7 @@ ClutterBehaviour ClutterBehaviourClass clutter_behaviour_apply clutter_behaviour_remove +clutter_behaviour_is_applied ClutterBehaviourForeachFunc clutter_behaviour_actors_foreach clutter_behaviour_get_actors @@ -366,6 +368,7 @@ clutter_perspective_get_type ClutterTimeline ClutterTimelineClass clutter_timeline_new +clutter_timeline_copy clutter_timeline_set_speed clutter_timeline_get_speed clutter_timeline_start @@ -456,6 +459,7 @@ clutter_behaviour_rotate_get_bounds clutter_behaviour_rotate_get_boundsx clutter_behaviour_rotate_get_direction +CLUTTER_TYPE_BEHAVIOUR_ROTATE CLUTTER_BEHAVIOUR_ROTATE CLUTTER_IS_BEHAVIOUR_ROTATE CLUTTER_BEHAVIOUR_ROTATE_CLASS @@ -474,6 +478,9 @@ ClutterBehaviourScale ClutterBehaviourScaleClass clutter_behaviour_scale_new clutter_behaviour_scale_newx +clutter_behaviour_scale_get_bounds +clutter_behaviour_scale_get_boundsx +clutter_behaviour_scale_get_gravity CLUTTER_BEHAVIOUR_SCALE CLUTTER_IS_BEHAVIOUR_SCALE @@ -502,6 +509,7 @@ clutter_behaviour_bspline_adjust clutter_behaviour_bspline_set_origin clutter_behaviour_bspline_get_origin +CLUTTER_TYPE_BEHAVIOUR_BSPLINE CLUTTER_BEHAVIOUR_BSPLINE CLUTTER_BEHAVIOUR_BSPLINE_CLASS CLUTTER_IS_BEHAVIOUR_BSPLINE @@ -520,7 +528,18 @@ ClutterBehaviourEllipseClass clutter_behaviour_ellipse_new clutter_behaviour_ellipse_set_center clutter_behaviour_ellipse_get_center +clutter_behaviour_ellipse_get_angle_begin +clutter_behaviour_ellipse_get_angle_end +clutter_behaviour_ellipse_get_angle_tilt +clutter_behaviour_ellipse_get_height +clutter_behaviour_ellipse_get_width +clutter_behaviour_ellipse_set_angle_begin +clutter_behaviour_ellipse_set_angle_end +clutter_behaviour_ellipse_set_angle_tilt +clutter_behaviour_ellipse_set_height +clutter_behaviour_ellipse_set_width +CLUTTER_TYPE_BEHAVIOUR_ELLIPSE CLUTTER_BEHAVIOUR_ELLIPSE CLUTTER_BEHAVIOUR_ELLIPSE_CLASS CLUTTER_IS_BEHAVIOUR_ELLIPSE diff --git a/doc/reference/clutter.types b/doc/reference/clutter.types index 6039e4ca6..3a8599c7f 100644 --- a/doc/reference/clutter.types +++ b/doc/reference/clutter.types @@ -7,6 +7,7 @@ clutter_rectangle_get_type clutter_texture_get_type clutter_clone_texture_get_type clutter_label_get_type +clutter_layout_get_type clutter_timeline_get_type clutter_media_get_type clutter_behaviour_get_type diff --git a/doc/reference/tmpl/clutter-behaviour-scale.sgml b/doc/reference/tmpl/clutter-behaviour-scale.sgml index 7695eeffe..6ca61cfe7 100644 --- a/doc/reference/tmpl/clutter-behaviour-scale.sgml +++ b/doc/reference/tmpl/clutter-behaviour-scale.sgml @@ -86,3 +86,32 @@ Class structure for #ClutterBehaviourScale. @Returns: + + + + + +@scale: +@scale_begin: +@scale_end: + + + + + + + +@scale: +@scale_begin: +@scale_end: + + + + + + + +@scale: +@Returns: + + diff --git a/doc/reference/tmpl/clutter-behaviour.sgml b/doc/reference/tmpl/clutter-behaviour.sgml index ce3161db5..18f0c76af 100644 --- a/doc/reference/tmpl/clutter-behaviour.sgml +++ b/doc/reference/tmpl/clutter-behaviour.sgml @@ -64,6 +64,16 @@ Class structure. @actor: + + + + + +@behave: +@actor: +@Returns: + + The function used to iterate on every #ClutterActor to which a behaviour diff --git a/doc/reference/tmpl/clutter-timeline.sgml b/doc/reference/tmpl/clutter-timeline.sgml index 23aa2dede..fd61d1532 100644 --- a/doc/reference/tmpl/clutter-timeline.sgml +++ b/doc/reference/tmpl/clutter-timeline.sgml @@ -93,6 +93,15 @@ The #ClutterTimeline has been started. @Returns: + + + + + +@timeline: +@Returns: + +