From 6f6950f4cc48e0f46dbde17dffe81f6c785f7a39 Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Mon, 16 Apr 2007 10:25:53 +0000 Subject: [PATCH] Add missing types and sections in the API documentation. Fix the ClutterBehaviourBspline header file. Fix typos in ClutterBehaviourRotate API documentation. --- clutter/clutter-behaviour-bspline.c | 35 +++++++++-------- clutter/clutter-behaviour-bspline.h | 61 +++++++++++++---------------- clutter/clutter-behaviour-rotate.c | 2 +- doc/reference/clutter-docs.sgml | 2 + doc/reference/clutter-sections.txt | 26 ++++++++++++ doc/reference/clutter.types | 3 ++ 6 files changed, 77 insertions(+), 52 deletions(-) diff --git a/clutter/clutter-behaviour-bspline.c b/clutter/clutter-behaviour-bspline.c index a58236b76..6ff3e851c 100644 --- a/clutter/clutter-behaviour-bspline.c +++ b/clutter/clutter-behaviour-bspline.c @@ -43,7 +43,7 @@ * Each time the behaviour reaches a point on the path, the "knot-reached" * signal is emitted. * - * Since: 0.3 + * Since: 0.4 */ #include "clutter-fixed.h" @@ -638,7 +638,7 @@ clutter_behaviour_bspline_init (ClutterBehaviourBspline * self) * * Return value: a #ClutterBehaviour * - * Since: 0.3 + * Since: 0.4 */ ClutterBehaviour * clutter_behaviour_bspline_new (ClutterAlpha *alpha, @@ -724,7 +724,7 @@ clutter_behaviour_bspline_append_spline (ClutterBehaviourBspline * bs, * a temporary chache, and only when there are enough control points to * create a new bezier curve will the bspline extended. * - * Since: 0.3 + * Since: 0.4 */ void clutter_behaviour_bspline_append_knot (ClutterBehaviourBspline * bs, @@ -776,14 +776,15 @@ clutter_behaviour_bspline_append_knots_valist (ClutterBehaviourBspline *bs, /** * clutter_behaviour_bspline_append: - * @bs: a #ClutterBehaviourBspline - * @knots: a NULL-terminated array of #ClutterKnot control points. + * @bs: a #ClutterBehaviourBspline + * @first_knot: first #ClutterKnot + * @VarArgs: a NULL-terminated array of #ClutterKnot control points. * * Appends a bezier spline defined by the last control point of bezier spline * bs and the array of #ClutterKnot control points to the orginal bezier spline * bs. * - * Since: 0.3 + * Since: 0.4 */ void clutter_behaviour_bspline_append (ClutterBehaviourBspline * bs, @@ -809,11 +810,11 @@ clutter_behaviour_bspline_append (ClutterBehaviourBspline * bs, * offset is not one of the on-curve points, the bspline will be * truncated at the nearest preceeding on-curve point. * - * Since: 0.3 + * Since: 0.4 */ void clutter_behaviour_bspline_truncate (ClutterBehaviourBspline *bs, - guint offset) + guint offset) { guint i; @@ -846,7 +847,7 @@ clutter_behaviour_bspline_truncate (ClutterBehaviourBspline *bs, * * Empties a bspline. * - * Since: 0.3 + * Since: 0.4 */ void clutter_behaviour_bspline_clear (ClutterBehaviourBspline * bs) @@ -882,7 +883,7 @@ clutter_behaviour_bspline_clear (ClutterBehaviourBspline * bs) * Joins a copy of bezier spline bs2 onto the end of bezier spline bs1; bs2 is * not modified. * - * Since: 0.3 + * Since: 0.4 */ void clutter_behaviour_bspline_join (ClutterBehaviourBspline * bs1, @@ -928,7 +929,7 @@ clutter_behaviour_bspline_join (ClutterBehaviourBspline * bs1, * bspline will be split at the nearest on-curve point before the offset. * The original bspline is shortened appropriately. * - * Since: 0.3 + * Since: 0.4 */ ClutterBehaviourBspline * clutter_behaviour_bspline_split (ClutterBehaviourBspline * bs, guint offset) @@ -971,14 +972,14 @@ clutter_behaviour_bspline_split (ClutterBehaviourBspline * bs, guint offset) /** * clutter_behaviour_bspline_adjust: - * @bs: a #ClutterBehaviourBspline - * @index: an index of control point to ajdust - * @knot: a #ClutterKnot with new coordinances for the control point. + * @bs: a #ClutterBehaviourBspline + * @offset: an index of control point to ajdust + * @knot: a #ClutterKnot with new coordinances for the control point. * * Change the coordinaces of control point at index to those represented by * the knot. * - * Since: 0.3 + * Since: 0.4 */ void clutter_behaviour_bspline_adjust (ClutterBehaviourBspline * bs, @@ -1052,7 +1053,7 @@ clutter_behaviour_bspline_adjust (ClutterBehaviourBspline * bs, * the origin of a bspline is given by the position of the first control point * of the first bezier curve.) * - * Since: 0.3 + * Since: 0.4 */ void clutter_behaviour_bspline_set_origin (ClutterBehaviourBspline * bs, @@ -1086,7 +1087,7 @@ clutter_behaviour_bspline_set_origin (ClutterBehaviourBspline * bs, * * Gets the origin of the bezier. * - * Since: 0.3 + * Since: 0.4 */ void clutter_behaviour_bspline_get_origin (ClutterBehaviourBspline * bs, diff --git a/clutter/clutter-behaviour-bspline.h b/clutter/clutter-behaviour-bspline.h index 6117d612e..0aa6c5a4e 100644 --- a/clutter/clutter-behaviour-bspline.h +++ b/clutter/clutter-behaviour-bspline.h @@ -60,7 +60,9 @@ typedef struct _ClutterBehaviourBsplineClass ClutterBehaviourBsplineClass; struct _ClutterBehaviourBspline { - ClutterBehaviour parent; + ClutterBehaviour parent_instance; + + /*< private >*/ ClutterBehaviourBsplinePrivate *priv; }; @@ -68,8 +70,8 @@ struct _ClutterBehaviourBsplineClass { ClutterBehaviourClass parent_class; - void (*knot_reached) (ClutterBehaviourBspline * bsplineb, - const ClutterKnot * knot); + void (*knot_reached) (ClutterBehaviourBspline *bsplineb, + const ClutterKnot *knot); void (*_clutter_bspline_1) (void); void (*_clutter_bspline_2) (void); @@ -79,37 +81,28 @@ struct _ClutterBehaviourBsplineClass GType clutter_behaviour_bspline_get_type (void) G_GNUC_CONST; -ClutterBehaviour * clutter_behaviour_bspline_new (ClutterAlpha * alpha, - const ClutterKnot * points, - guint n_points); - -void clutter_behaviour_bspline_append_knot (ClutterBehaviourBspline * bs, - const ClutterKnot * knot); - -void clutter_behaviour_bspline_append (ClutterBehaviourBspline * bs, - const ClutterKnot * first_knot, - ...) G_GNUC_NULL_TERMINATED; - -void clutter_behaviour_bspline_truncate (ClutterBehaviourBspline *bs, - guint offset); - -void clutter_behaviour_bspline_join (ClutterBehaviourBspline * bs1, - ClutterBehaviourBspline * bs2); - -ClutterBehaviourBspline * clutter_behaviour_bspline_split (ClutterBehaviourBspline * bs, - guint offset); - -void clutter_behaviour_bspline_clear (ClutterBehaviourBspline * bs); - -void clutter_behaviour_bspline_adjust (ClutterBehaviourBspline * bs, - guint offset, - ClutterKnot * knot); - -void clutter_behaviour_bspline_set_origin (ClutterBehaviourBspline * bs, - ClutterKnot * knot); - -void clutter_behaviour_bspline_get_origin (ClutterBehaviourBspline * bs, - ClutterKnot * knot); +ClutterBehaviour *clutter_behaviour_bspline_new (ClutterAlpha *alpha, + const ClutterKnot *knots, + guint n_knots); +void clutter_behaviour_bspline_append_knot (ClutterBehaviourBspline *bs, + const ClutterKnot *knot); +void clutter_behaviour_bspline_append (ClutterBehaviourBspline *bs, + const ClutterKnot *first_knot, + ...) G_GNUC_NULL_TERMINATED; +void clutter_behaviour_bspline_truncate (ClutterBehaviourBspline *bs, + guint offset); +void clutter_behaviour_bspline_join (ClutterBehaviourBspline *bs1, + ClutterBehaviourBspline *bs2); +ClutterBehaviour *clutter_behaviour_bspline_split (ClutterBehaviourBspline *bs, + guint offset); +void clutter_behaviour_bspline_clear (ClutterBehaviourBspline *bs); +void clutter_behaviour_bspline_adjust (ClutterBehaviourBspline *bs, + guint offset, + ClutterKnot *knot); +void clutter_behaviour_bspline_set_origin (ClutterBehaviourBspline *bs, + ClutterKnot *knot); +void clutter_behaviour_bspline_get_origin (ClutterBehaviourBspline *bs, + ClutterKnot *knot); G_END_DECLS diff --git a/clutter/clutter-behaviour-rotate.c b/clutter/clutter-behaviour-rotate.c index 0b40651f3..801932b5b 100644 --- a/clutter/clutter-behaviour-rotate.c +++ b/clutter/clutter-behaviour-rotate.c @@ -308,7 +308,7 @@ clutter_behaviour_rotate_new (ClutterAlpha *alpha, * @axis: the rotation axis * @direction: the rotation direction * @angle_begin: the starting angle, in fixed point notation - * @andle_end: the final angle, in fixed point notation + * @angle_end: the final angle, in fixed point notation * * Creates a new #ClutterBehaviourRotate. This is the fixed point version * of clutter_behaviour_rotate_new(). diff --git a/doc/reference/clutter-docs.sgml b/doc/reference/clutter-docs.sgml index 529908fa9..3972aed99 100644 --- a/doc/reference/clutter-docs.sgml +++ b/doc/reference/clutter-docs.sgml @@ -79,8 +79,10 @@ Clutter Behaviours + + diff --git a/doc/reference/clutter-sections.txt b/doc/reference/clutter-sections.txt index 7e0282e03..755d7b954 100644 --- a/doc/reference/clutter-sections.txt +++ b/doc/reference/clutter-sections.txt @@ -470,6 +470,32 @@ ClutterBehaviourScalePrivate clutter_behaviour_scale_get_type +
+clutter-behaviour-bspline +ClutterBehaviourBspline +ClutterBehaviourBspline +ClutterBehaviourBsplineClass +clutter_behaviour_bspline_new +clutter_behaviour_bspline_append_knot +clutter_behaviour_bspline_append +clutter_behaviour_bspline_truncate +clutter_behaviour_bspline_join +clutter_behaviour_bspline_split +clutter_behaviour_bspline_clear +clutter_behaviour_bspline_adjust +clutter_behaviour_bspline_set_origin +clutter_behaviour_bspline_get_origin + +CLUTTER_BEHAVIOUR_BSPLINE +CLUTTER_BEHAVIOUR_BSPLINE_CLASS +CLUTTER_IS_BEHAVIOUR_BSPLINE +CLUTTER_IS_BEHAVIOUR_BSPLINE_CLASS +CLUTTER_BEHAVIOUR_BSPLINE_GET_CLASS + +ClutterBehaviourBsplinePrivate +clutter_behaviour_bspline_get_type +
+
clutter-backend ClutterBackend diff --git a/doc/reference/clutter.types b/doc/reference/clutter.types index 80f55edbf..74b1b0b96 100644 --- a/doc/reference/clutter.types +++ b/doc/reference/clutter.types @@ -11,6 +11,9 @@ clutter_timeline_get_type clutter_media_get_type clutter_behaviour_get_type clutter_alpha_get_type +clutter_behaviour_bspline_get_type clutter_behaviour_opacity_get_type clutter_behaviour_path_get_type +clutter_behaviour_rotate_get_type clutter_behaviour_scale_get_type +clutter_backend_get_type