isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-12-22 19:12:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add missing types and sections in the API documentation.

Browse Source 
Fix the ClutterBehaviourBspline header file. Fix typos in
ClutterBehaviourRotate API documentation.
This commit is contained in:
Emmanuele Bassi 2007-04-16 10:25:53 +00:00
parent 05eedd6f8f
commit 6f6950f4cc
6 changed files with 77 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
clutter/clutter-behaviour-bspline.c
View File

@ -43,7 +43,7 @@
* Each time the behaviour reaches a point on the path, the "knot-reached" * Each time the behaviour reaches a point on the path, the "knot-reached"
* signal is emitted. * signal is emitted.
* *
* Since: 0.3 * Since: 0.4
*/ */
#include "clutter-fixed.h" #include "clutter-fixed.h"
@ -638,7 +638,7 @@ clutter_behaviour_bspline_init (ClutterBehaviourBspline * self)
* *
* Return value: a #ClutterBehaviour * Return value: a #ClutterBehaviour
* *
* Since: 0.3 * Since: 0.4
*/ */
ClutterBehaviour * ClutterBehaviour *
clutter_behaviour_bspline_new (ClutterAlpha *alpha, 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 * a temporary chache, and only when there are enough control points to
* create a new bezier curve will the bspline extended. * create a new bezier curve will the bspline extended.
* *
* Since: 0.3 * Since: 0.4
*/ */
void void
clutter_behaviour_bspline_append_knot (ClutterBehaviourBspline * bs, clutter_behaviour_bspline_append_knot (ClutterBehaviourBspline * bs,
@ -777,13 +777,14 @@ clutter_behaviour_bspline_append_knots_valist (ClutterBehaviourBspline *bs,
/** /**
* clutter_behaviour_bspline_append: * clutter_behaviour_bspline_append:
* @bs: a #ClutterBehaviourBspline * @bs: a #ClutterBehaviourBspline
* @knots: a NULL-terminated array of #ClutterKnot control points. * @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 * 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 and the array of #ClutterKnot control points to the orginal bezier spline
* bs. * bs.
* *
* Since: 0.3 * Since: 0.4
*/ */
void void
clutter_behaviour_bspline_append (ClutterBehaviourBspline * bs, clutter_behaviour_bspline_append (ClutterBehaviourBspline * bs,
@ -809,7 +810,7 @@ clutter_behaviour_bspline_append (ClutterBehaviourBspline * bs,
* offset is not one of the on-curve points, the bspline will be * offset is not one of the on-curve points, the bspline will be
* truncated at the nearest preceeding on-curve point. * truncated at the nearest preceeding on-curve point.
* *
* Since: 0.3 * Since: 0.4
*/ */
void void
clutter_behaviour_bspline_truncate (ClutterBehaviourBspline *bs, clutter_behaviour_bspline_truncate (ClutterBehaviourBspline *bs,
@ -846,7 +847,7 @@ clutter_behaviour_bspline_truncate (ClutterBehaviourBspline *bs,
* *
* Empties a bspline. * Empties a bspline.
* *
* Since: 0.3 * Since: 0.4
*/ */
void void
clutter_behaviour_bspline_clear (ClutterBehaviourBspline * bs) 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 * Joins a copy of bezier spline bs2 onto the end of bezier spline bs1; bs2 is
* not modified. * not modified.
* *
* Since: 0.3 * Since: 0.4
*/ */
void void
clutter_behaviour_bspline_join (ClutterBehaviourBspline * bs1, 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. * bspline will be split at the nearest on-curve point before the offset.
* The original bspline is shortened appropriately. * The original bspline is shortened appropriately.
* *
* Since: 0.3 * Since: 0.4
*/ */
ClutterBehaviourBspline * ClutterBehaviourBspline *
clutter_behaviour_bspline_split (ClutterBehaviourBspline * bs, guint offset) clutter_behaviour_bspline_split (ClutterBehaviourBspline * bs, guint offset)
@ -972,13 +973,13 @@ clutter_behaviour_bspline_split (ClutterBehaviourBspline * bs, guint offset)
/** /**
* clutter_behaviour_bspline_adjust: * clutter_behaviour_bspline_adjust:
* @bs: a #ClutterBehaviourBspline * @bs: a #ClutterBehaviourBspline
* @index: an index of control point to ajdust * @offset: an index of control point to ajdust
* @knot: a #ClutterKnot with new coordinances for the control point. * @knot: a #ClutterKnot with new coordinances for the control point.
* *
* Change the coordinaces of control point at index to those represented by * Change the coordinaces of control point at index to those represented by
* the knot. * the knot.
* *
* Since: 0.3 * Since: 0.4
*/ */
void void
clutter_behaviour_bspline_adjust (ClutterBehaviourBspline * bs, 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 * the origin of a bspline is given by the position of the first control point
* of the first bezier curve.) * of the first bezier curve.)
* *
* Since: 0.3 * Since: 0.4
*/ */
void void
clutter_behaviour_bspline_set_origin (ClutterBehaviourBspline * bs, clutter_behaviour_bspline_set_origin (ClutterBehaviourBspline * bs,
@ -1086,7 +1087,7 @@ clutter_behaviour_bspline_set_origin (ClutterBehaviourBspline * bs,
* *
* Gets the origin of the bezier. * Gets the origin of the bezier.
* *
* Since: 0.3 * Since: 0.4
*/ */
void void
clutter_behaviour_bspline_get_origin (ClutterBehaviourBspline * bs, clutter_behaviour_bspline_get_origin (ClutterBehaviourBspline * bs,

51
clutter/clutter-behaviour-bspline.h
View File

@ -60,7 +60,9 @@ typedef struct _ClutterBehaviourBsplineClass ClutterBehaviourBsplineClass;
struct _ClutterBehaviourBspline struct _ClutterBehaviourBspline
{ {
ClutterBehaviour parent; ClutterBehaviour parent_instance;
/*< private >*/
ClutterBehaviourBsplinePrivate *priv; ClutterBehaviourBsplinePrivate *priv;
}; };
@ -68,8 +70,8 @@ struct _ClutterBehaviourBsplineClass
{ {
ClutterBehaviourClass parent_class; ClutterBehaviourClass parent_class;
void (*knot_reached) (ClutterBehaviourBspline * bsplineb, void (*knot_reached) (ClutterBehaviourBspline *bsplineb,
const ClutterKnot * knot); const ClutterKnot *knot);
void (*_clutter_bspline_1) (void); void (*_clutter_bspline_1) (void);
void (*_clutter_bspline_2) (void); void (*_clutter_bspline_2) (void);
@ -79,37 +81,28 @@ struct _ClutterBehaviourBsplineClass
GType clutter_behaviour_bspline_get_type (void) G_GNUC_CONST; GType clutter_behaviour_bspline_get_type (void) G_GNUC_CONST;
ClutterBehaviour * clutter_behaviour_bspline_new (ClutterAlpha * alpha, ClutterBehaviour *clutter_behaviour_bspline_new (ClutterAlpha *alpha,
const ClutterKnot * points, const ClutterKnot *knots,
guint n_points); guint n_knots);
void clutter_behaviour_bspline_append_knot (ClutterBehaviourBspline *bs,
void clutter_behaviour_bspline_append_knot (ClutterBehaviourBspline * bs, const ClutterKnot *knot);
const ClutterKnot * knot); void clutter_behaviour_bspline_append (ClutterBehaviourBspline *bs,
const ClutterKnot *first_knot,
void clutter_behaviour_bspline_append (ClutterBehaviourBspline * bs,
const ClutterKnot * first_knot,
...) G_GNUC_NULL_TERMINATED; ...) G_GNUC_NULL_TERMINATED;
void clutter_behaviour_bspline_truncate (ClutterBehaviourBspline *bs, void clutter_behaviour_bspline_truncate (ClutterBehaviourBspline *bs,
guint offset); guint offset);
void clutter_behaviour_bspline_join (ClutterBehaviourBspline *bs1,
void clutter_behaviour_bspline_join (ClutterBehaviourBspline * bs1, ClutterBehaviourBspline *bs2);
ClutterBehaviourBspline * bs2); ClutterBehaviour *clutter_behaviour_bspline_split (ClutterBehaviourBspline *bs,
ClutterBehaviourBspline * clutter_behaviour_bspline_split (ClutterBehaviourBspline * bs,
guint offset); guint offset);
void clutter_behaviour_bspline_clear (ClutterBehaviourBspline *bs);
void clutter_behaviour_bspline_clear (ClutterBehaviourBspline * bs); void clutter_behaviour_bspline_adjust (ClutterBehaviourBspline *bs,
void clutter_behaviour_bspline_adjust (ClutterBehaviourBspline * bs,
guint offset, guint offset,
ClutterKnot * knot); ClutterKnot *knot);
void clutter_behaviour_bspline_set_origin (ClutterBehaviourBspline *bs,
void clutter_behaviour_bspline_set_origin (ClutterBehaviourBspline * bs, ClutterKnot *knot);
ClutterKnot * knot); void clutter_behaviour_bspline_get_origin (ClutterBehaviourBspline *bs,
ClutterKnot *knot);
void clutter_behaviour_bspline_get_origin (ClutterBehaviourBspline * bs,
ClutterKnot * knot);
G_END_DECLS G_END_DECLS

2
clutter/clutter-behaviour-rotate.c
View File

@ -308,7 +308,7 @@ clutter_behaviour_rotate_new (ClutterAlpha *alpha,
* @axis: the rotation axis * @axis: the rotation axis
* @direction: the rotation direction * @direction: the rotation direction
* @angle_begin: the starting angle, in fixed point notation * @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 * Creates a new #ClutterBehaviourRotate. This is the fixed point version
* of clutter_behaviour_rotate_new(). * of clutter_behaviour_rotate_new().

2
doc/reference/clutter-docs.sgml
View File

@ -79,8 +79,10 @@
<title>Clutter Behaviours</title> <title>Clutter Behaviours</title>
<xi:include href="xml/clutter-alpha.xml"/> <xi:include href="xml/clutter-alpha.xml"/>
<xi:include href="xml/clutter-behaviour.xml"/> <xi:include href="xml/clutter-behaviour.xml"/>
<xi:include href="xml/clutter-behaviour-bspline.xml"/>
<xi:include href="xml/clutter-behaviour-opacity.xml"/> <xi:include href="xml/clutter-behaviour-opacity.xml"/>
<xi:include href="xml/clutter-behaviour-path.xml"/> <xi:include href="xml/clutter-behaviour-path.xml"/>
<xi:include href="xml/clutter-behaviour-rotate.xml"/>
<xi:include href="xml/clutter-behaviour-scale.xml"/> <xi:include href="xml/clutter-behaviour-scale.xml"/>
</chapter> </chapter>
<chapter> <chapter>

26
doc/reference/clutter-sections.txt
View File

@ -470,6 +470,32 @@ ClutterBehaviourScalePrivate
clutter_behaviour_scale_get_type clutter_behaviour_scale_get_type
</SECTION> </SECTION>
<SECTION>
<FILE>clutter-behaviour-bspline</FILE>
<TITLE>ClutterBehaviourBspline</TITLE>
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
<SUBSECTION Standard>
CLUTTER_BEHAVIOUR_BSPLINE
CLUTTER_BEHAVIOUR_BSPLINE_CLASS
CLUTTER_IS_BEHAVIOUR_BSPLINE
CLUTTER_IS_BEHAVIOUR_BSPLINE_CLASS
CLUTTER_BEHAVIOUR_BSPLINE_GET_CLASS
<SUBSECTION Private>
ClutterBehaviourBsplinePrivate
clutter_behaviour_bspline_get_type
</SECTION>
<SECTION> <SECTION>
<FILE>clutter-backend</FILE> <FILE>clutter-backend</FILE>
<TITLE>ClutterBackend</TITLE> <TITLE>ClutterBackend</TITLE>

3
doc/reference/clutter.types
View File

@ -11,6 +11,9 @@ clutter_timeline_get_type
clutter_media_get_type clutter_media_get_type
clutter_behaviour_get_type clutter_behaviour_get_type
clutter_alpha_get_type clutter_alpha_get_type
clutter_behaviour_bspline_get_type
clutter_behaviour_opacity_get_type clutter_behaviour_opacity_get_type
clutter_behaviour_path_get_type clutter_behaviour_path_get_type
clutter_behaviour_rotate_get_type
clutter_behaviour_scale_get_type clutter_behaviour_scale_get_type
clutter_backend_get_type