From e1a8434d646a63f4af96b87bb5cd3051342690ba Mon Sep 17 00:00:00 2001 From: Tomas Frydrych Date: Fri, 1 Jun 2007 10:00:35 +0000 Subject: [PATCH] Documentation updates --- ChangeLog | 9 ++++ clutter/clutter-behaviour-bspline.c | 2 +- clutter/clutter-behaviour-bspline.h | 2 - clutter/clutter-behaviour-ellipse.c | 6 +-- clutter/clutter-behaviour-ellipse.h | 8 ++- clutter/clutter-fixed.h | 4 +- doc/reference/ChangeLog | 10 ++++ doc/reference/tmpl/clutter-alpha.sgml | 14 ++--- .../tmpl/clutter-behaviour-bspline.sgml | 5 +- .../tmpl/clutter-behaviour-ellipse.sgml | 9 ++-- .../tmpl/clutter-behaviour-rotate.sgml | 5 +- doc/reference/tmpl/clutter-fixed.sgml | 5 +- doc/reference/tmpl/clutter-units.sgml | 51 +++++++++++-------- 13 files changed, 80 insertions(+), 50 deletions(-) diff --git a/ChangeLog b/ChangeLog index 28dccb888..924b8aeb4 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,12 @@ +2007-06-01 Tomas Frydrych + + * clutter/clutter-fixed.h: + * clutter/clutter-behaviour-ellipse.h: + * clutter/clutter-behaviour-ellipse.c: + * clutter/clutter-behaviour-bspline.h: + * clutter/clutter-behaviour-bspline.c: + Documentation fixes. + 2007-05-31 Tomas Frydrych * clutter/clutter-stage.c: diff --git a/clutter/clutter-behaviour-bspline.c b/clutter/clutter-behaviour-bspline.c index 0ab7d3107..e8ed03cdc 100644 --- a/clutter/clutter-behaviour-bspline.c +++ b/clutter/clutter-behaviour-bspline.c @@ -29,7 +29,7 @@ * @short_description: A behaviour class interpolating actors along a path * defined by bezier spline. * - * #ClutterBehaviourBspline interpolates actors along a defined bsplien path. + * #ClutterBehaviourBspline interpolates actors along a defined bspline path. * * A bezier spline is a set of cubic bezier curves defined by a sequence of * control points given when creating a new #ClutterBehaviourBspline instance. diff --git a/clutter/clutter-behaviour-bspline.h b/clutter/clutter-behaviour-bspline.h index 0aa6c5a4e..f08dafc6e 100644 --- a/clutter/clutter-behaviour-bspline.h +++ b/clutter/clutter-behaviour-bspline.h @@ -61,8 +61,6 @@ typedef struct _ClutterBehaviourBsplineClass ClutterBehaviourBsplineClass; struct _ClutterBehaviourBspline { ClutterBehaviour parent_instance; - - /*< private >*/ ClutterBehaviourBsplinePrivate *priv; }; diff --git a/clutter/clutter-behaviour-ellipse.c b/clutter/clutter-behaviour-ellipse.c index 51a9937bd..3db2f1fe8 100644 --- a/clutter/clutter-behaviour-ellipse.c +++ b/clutter/clutter-behaviour-ellipse.c @@ -29,7 +29,7 @@ * @short_description: elliptic path behaviour. * * #ClutterBehaviourEllipse interpolates actors along a path defined by - * en ellipse. + * an ellipse. * * Since: 0.4 */ @@ -540,7 +540,7 @@ clutter_behaviour_ellipse_set_width (ClutterBehaviourEllipse * self, * * Gets the width of the elliptical path. * - * Return: the width of the path + * Return value: the width of the path * * Since: 0.4 */ @@ -670,7 +670,7 @@ clutter_behaviour_ellipse_get_angle_end (ClutterBehaviourEllipse * self) /** * clutter_behaviour_ellipse_set_angle_tilt * @self: a #ClutterBehaviourEllipse - * @angle_end: #ClutterAngle tilt of the elipse around the center + * @angle_tilt: #ClutterAngle tilt of the elipse around the center * * Sets the angle at which the ellipse should be tilted around it's center. * diff --git a/clutter/clutter-behaviour-ellipse.h b/clutter/clutter-behaviour-ellipse.h index 11e07dca5..eb3a8a65e 100644 --- a/clutter/clutter-behaviour-ellipse.h +++ b/clutter/clutter-behaviour-ellipse.h @@ -61,8 +61,6 @@ typedef struct _ClutterBehaviourEllipseClass ClutterBehaviourEllipseClass; struct _ClutterBehaviourEllipse { ClutterBehaviour parent_instance; - - /*< private >*/ ClutterBehaviourEllipsePrivate *priv; }; @@ -86,7 +84,7 @@ ClutterBehaviour *clutter_behaviour_ellipse_new (ClutterAlpha gint y, gint width, gint height, - gdouble start, + gdouble begin, gdouble end, gdouble tilt); @@ -95,7 +93,7 @@ ClutterBehaviour *clutter_behaviour_ellipse_newx (ClutterAlpha gint y, gint width, gint height, - ClutterFixed start, + ClutterFixed begin, ClutterFixed end, ClutterFixed tilt); @@ -103,7 +101,7 @@ void clutter_behaviour_ellipse_set_center (ClutterBehaviourEll gint x, gint y); -void clutter_behaviour_ellipse_get_center (ClutterBehaviourEllipse * bs, +void clutter_behaviour_ellipse_get_center (ClutterBehaviourEllipse * self, gint * x, gint * y); diff --git a/clutter/clutter-fixed.h b/clutter/clutter-fixed.h index c7104103d..a41707a81 100644 --- a/clutter/clutter-fixed.h +++ b/clutter/clutter-fixed.h @@ -76,13 +76,13 @@ typedef gint32 ClutterAngle; /* angle such that 1024 == 2*PI */ */ #define CFX_2PI 0x0006487f /** - * CFX_PI2: + * CFX_PI_2: * * Fixed point representation of Pi/2 */ #define CFX_PI_2 0x00019220 /* pi/2 */ /** - * CFX_PI4: + * CFX_PI_4: * * Fixed point representation of Pi/4 */ diff --git a/doc/reference/ChangeLog b/doc/reference/ChangeLog index 29b0bf6c0..5904191ab 100644 --- a/doc/reference/ChangeLog +++ b/doc/reference/ChangeLog @@ -1,3 +1,13 @@ +2007-06-01 Tomas Frydrych + + * tmpl/clutter-alpha.sgml: + * tmpl/clutter-fixed.sgml: + * tmpl/clutter-units.sgml: + * tmpl/clutter-behaviour-rotate.sgml: + * tmpl/clutter-behaviour-bspline.sgml: + * tmpl/clutter-behaviour-ellipse.sgml: + Updated templates. + 2007-05-31 Neil J Patel * clutter-docs.sgml: diff --git a/doc/reference/tmpl/clutter-alpha.sgml b/doc/reference/tmpl/clutter-alpha.sgml index 1c1bb1913..10bc72b69 100644 --- a/doc/reference/tmpl/clutter-alpha.sgml +++ b/doc/reference/tmpl/clutter-alpha.sgml @@ -36,7 +36,7 @@ accessed directly. - +Class structure for #ClutterApha. @parent_class: @@ -193,7 +193,7 @@ Symbolic name for passing clutter_sine_func(). - +Symbolic name for passing clutter_sine_inc_func(). @@ -210,7 +210,7 @@ Symbolic name for passing clutter_sine_func(). - +Symbolic name for passing clutter_sine_dec_func(). @@ -227,7 +227,7 @@ Symbolic name for passing clutter_sine_func(). - +Symbolic name for passing clutter_sine_hav_func(). @@ -244,7 +244,7 @@ Symbolic name for passing clutter_sine_func(). - +Symbolic name for passing clutter_square_func(). @@ -261,7 +261,7 @@ Symbolic name for passing clutter_sine_func(). - +Symbolic name for passing clutter_exp_inc_func(). @@ -278,7 +278,7 @@ Symbolic name for passing clutter_sine_func(). - +Symbolic name for passing clutter_exp_dec_func(). diff --git a/doc/reference/tmpl/clutter-behaviour-bspline.sgml b/doc/reference/tmpl/clutter-behaviour-bspline.sgml index ac8e0bede..55a3dc55e 100644 --- a/doc/reference/tmpl/clutter-behaviour-bspline.sgml +++ b/doc/reference/tmpl/clutter-behaviour-bspline.sgml @@ -19,7 +19,8 @@ ClutterBehaviourBspline - +The ClutterBehaviourBspline structure contains +only private data, and should not be accessed directly. @@ -33,7 +34,7 @@ ClutterBehaviourBspline - +Class structure for #ClutterBehaviouBspline. @parent_class: diff --git a/doc/reference/tmpl/clutter-behaviour-ellipse.sgml b/doc/reference/tmpl/clutter-behaviour-ellipse.sgml index de1782637..8d9bf7729 100644 --- a/doc/reference/tmpl/clutter-behaviour-ellipse.sgml +++ b/doc/reference/tmpl/clutter-behaviour-ellipse.sgml @@ -19,7 +19,8 @@ ClutterBehaviourEllipse - +The ClutterBehaviourEllipse structure contains +only private data, and should not be accessed directly. @@ -55,7 +56,7 @@ ClutterBehaviourEllipse - +Class structure for #ClutterBehaviourEllipse. @parent_class: @@ -75,7 +76,7 @@ ClutterBehaviourEllipse @y: @width: @height: -@start: +@begin: @end: @tilt: @Returns: @@ -96,7 +97,7 @@ ClutterBehaviourEllipse -@bs: +@self: @x: @y: diff --git a/doc/reference/tmpl/clutter-behaviour-rotate.sgml b/doc/reference/tmpl/clutter-behaviour-rotate.sgml index dc6cfff08..26adb65cf 100644 --- a/doc/reference/tmpl/clutter-behaviour-rotate.sgml +++ b/doc/reference/tmpl/clutter-behaviour-rotate.sgml @@ -36,7 +36,8 @@ ClutterBehaviourRotate - +The ClutterBehaviourRotate structure contains +only private data, and should not be accessed directly. @@ -62,7 +63,7 @@ ClutterBehaviourRotate - +Class structure for #ClutterBehaviourRotate. @parent_class: diff --git a/doc/reference/tmpl/clutter-fixed.sgml b/doc/reference/tmpl/clutter-fixed.sgml index 9c42a6b1d..30cd43944 100644 --- a/doc/reference/tmpl/clutter-fixed.sgml +++ b/doc/reference/tmpl/clutter-fixed.sgml @@ -206,10 +206,11 @@ Macro for converting floating point numbers to #ClutterFixed. - +Macro for converting floating point numbers to intergers; this conversion +is significantly faster that casting floats to int. -@x: +@x: float diff --git a/doc/reference/tmpl/clutter-units.sgml b/doc/reference/tmpl/clutter-units.sgml index fae52512a..696b4f4cb 100644 --- a/doc/reference/tmpl/clutter-units.sgml +++ b/doc/reference/tmpl/clutter-units.sgml @@ -19,89 +19,100 @@ Clutter Units - +Macro for converting from device units to #ClutterUnit. -@x: +@x: int - +Macro for converting from #ClutterFixed pixels to #ClutterUnit. -@x: +@x: #ClutterFixed - +Macro for converting from floating point pixels to #ClutterUnit. -@x: +@x: float - +Macro for converting from pixels to #ClutterUnit. -@x: +@x: int - +Macro for converting from Pango units to #ClutterUnit. -@x: +@x: int +Macro to ease furture transition #ClutterUnit-based API. +This is presently an identity macro, that can be used around integer pixel +values passed into clutter functions. When the API is changed to use +#ClutterUnit, this macro will be modified to carry out pixel -> #ClutterUnit +conversion. -@x: +@x: int +Macro to ease furture transition #ClutterUnit-based API. +This is presently an identity macro, that can be used around integer pixel +values return from clutter functions. When the API is changed to return +#ClutterUnit, this macro will be modified to carry out #ClutterUnit -> +pixel conversion. -@x: +@x: int - +Macro for conversion from #ClutterUnit values to device unit (currently +pixels). -@x: +@x: #ClutterUnit - +Macro for conversion of #ClutterUnit value to #ClutterFixed pixel value. -@x: +@x: #ClutterUnit - +Macro for conversion of #ClutterUnit value to floating point pixel value. -@x: +@x: #ClutterUnit - +Macro for conversion of #ClutterUnit value to int pixel value. -@x: +@x: #ClutterUnit