Documentation updates

ChangeLog

@@ -1,3 +1,12 @@
+2007-06-01  Tomas Frydrych  <tf@openedhand.com>
+
+	* 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  <tf@openedhand.com>
 
 	* clutter/clutter-stage.c:

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.

clutter/clutter-behaviour-bspline.h

@@ -61,8 +61,6 @@ typedef struct _ClutterBehaviourBsplineClass   ClutterBehaviourBsplineClass;
 struct _ClutterBehaviourBspline
 {
   ClutterBehaviour parent_instance;
-
-  /*< private >*/
   ClutterBehaviourBsplinePrivate *priv;
 };
 

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.
  * 

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);
 

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
  */

doc/reference/ChangeLog

@@ -1,3 +1,13 @@
+2007-06-01  Tomas Frydrych  <tf@openedhand.com>
+
+	* 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  <njp@o-hand.com>
 
 	* clutter-docs.sgml:

doc/reference/tmpl/clutter-alpha.sgml

@@ -36,7 +36,7 @@ accessed directly.
 
 <!-- ##### STRUCT ClutterAlphaClass ##### -->
 <para>
-
+Class structure for #ClutterApha.
 </para>
 
 @parent_class: 
@@ -193,7 +193,7 @@ Symbolic name for passing clutter_sine_func().
 
 <!-- ##### MACRO CLUTTER_ALPHA_SINE_INC ##### -->
 <para>
-
+Symbolic name for passing clutter_sine_inc_func().
 </para>
 
 
@@ -210,7 +210,7 @@ Symbolic name for passing clutter_sine_func().
 
 <!-- ##### MACRO CLUTTER_ALPHA_SINE_DEC ##### -->
 <para>
-
+Symbolic name for passing clutter_sine_dec_func().
 </para>
 
 
@@ -227,7 +227,7 @@ Symbolic name for passing clutter_sine_func().
 
 <!-- ##### MACRO CLUTTER_ALPHA_SINE_HALF ##### -->
 <para>
-
+Symbolic name for passing clutter_sine_hav_func().
 </para>
 
 
@@ -244,7 +244,7 @@ Symbolic name for passing clutter_sine_func().
 
 <!-- ##### MACRO CLUTTER_ALPHA_SQUARE ##### -->
 <para>
-
+Symbolic name for passing clutter_square_func().
 </para>
 
 
@@ -261,7 +261,7 @@ Symbolic name for passing clutter_sine_func().
 
 <!-- ##### MACRO CLUTTER_ALPHA_EXP_INC ##### -->
 <para>
-
+Symbolic name for passing clutter_exp_inc_func().
 </para>
 
 
@@ -278,7 +278,7 @@ Symbolic name for passing clutter_sine_func().
 
 <!-- ##### MACRO CLUTTER_ALPHA_EXP_DEC ##### -->
 <para>
-
+Symbolic name for passing clutter_exp_dec_func().
 </para>
 
 

doc/reference/tmpl/clutter-behaviour-bspline.sgml

@@ -19,7 +19,8 @@ ClutterBehaviourBspline
 
 <!-- ##### STRUCT ClutterBehaviourBspline ##### -->
 <para>
-
+The <structname>ClutterBehaviourBspline</structname> structure contains
+only private data, and should not be accessed directly.
 </para>
 
 
@@ -33,7 +34,7 @@ ClutterBehaviourBspline
 
 <!-- ##### STRUCT ClutterBehaviourBsplineClass ##### -->
 <para>
-
+Class structure for #ClutterBehaviouBspline.
 </para>
 
 @parent_class: 

doc/reference/tmpl/clutter-behaviour-ellipse.sgml

@@ -19,7 +19,8 @@ ClutterBehaviourEllipse
 
 <!-- ##### STRUCT ClutterBehaviourEllipse ##### -->
 <para>
-
+The <structname>ClutterBehaviourEllipse</structname> structure contains
+only private data, and should not be accessed directly.
 </para>
 
 
@@ -55,7 +56,7 @@ ClutterBehaviourEllipse
 
 <!-- ##### STRUCT ClutterBehaviourEllipseClass ##### -->
 <para>
-
+Class structure for #ClutterBehaviourEllipse.
 </para>
 
 @parent_class: 
@@ -75,7 +76,7 @@ ClutterBehaviourEllipse
 @y: 
 @width: 
 @height: 
-@start: 
+@begin: 
 @end: 
 @tilt: 
 @Returns: 
@@ -96,7 +97,7 @@ ClutterBehaviourEllipse
 
 </para>
 
-@bs: 
+@self: 
 @x: 
 @y: 
 

doc/reference/tmpl/clutter-behaviour-rotate.sgml

@@ -36,7 +36,8 @@ ClutterBehaviourRotate
 
 <!-- ##### STRUCT ClutterBehaviourRotate ##### -->
 <para>
-
+The <structname>ClutterBehaviourRotate</structname> structure contains
+only private data, and should not be accessed directly.
 </para>
 
 
@@ -62,7 +63,7 @@ ClutterBehaviourRotate
 
 <!-- ##### STRUCT ClutterBehaviourRotateClass ##### -->
 <para>
-
+Class structure for #ClutterBehaviourRotate.
 </para>
 
 @parent_class: 

doc/reference/tmpl/clutter-fixed.sgml

@@ -206,10 +206,11 @@ Macro for converting floating point numbers to #ClutterFixed.
 
 <!-- ##### MACRO CLUTTER_FLOAT_TO_INT ##### -->
 <para>
-
+Macro for converting floating point numbers to intergers; this conversion
+is significantly faster that casting floats to int.
 </para>
 
-@x: 
+@x: float
 
 
 <!-- ##### MACRO CLUTTER_INT_TO_FIXED ##### -->

doc/reference/tmpl/clutter-units.sgml

@@ -19,89 +19,100 @@ Clutter Units
 
 <!-- ##### MACRO CLUTTER_UNITS_FROM_DEVICE ##### -->
 <para>
-
+Macro for converting from device units to #ClutterUnit.
 </para>
 
-@x: 
+@x: int
 
 
 <!-- ##### MACRO CLUTTER_UNITS_FROM_FIXED ##### -->
 <para>
-
+Macro for converting from #ClutterFixed pixels to #ClutterUnit.
 </para>
 
-@x: 
+@x: #ClutterFixed
 
 
 <!-- ##### MACRO CLUTTER_UNITS_FROM_FLOAT ##### -->
 <para>
-
+Macro for converting from floating point pixels to #ClutterUnit.
 </para>
 
-@x: 
+@x: float
 
 
 <!-- ##### MACRO CLUTTER_UNITS_FROM_INT ##### -->
 <para>
-
+Macro for converting from pixels to #ClutterUnit.
 </para>
 
-@x: 
+@x: int
 
 
 <!-- ##### MACRO CLUTTER_UNITS_FROM_PANGO_UNIT ##### -->
 <para>
-
+Macro for converting from Pango units to #ClutterUnit.
 </para>
 
-@x: 
+@x: int
 
 
 <!-- ##### MACRO CLUTTER_UNITS_TMP_FROM_DEVICE ##### -->
 <para>
+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 -&gt; #ClutterUnit
+conversion.
 </para>
 
-@x: 
+@x: int
 
 
 <!-- ##### MACRO CLUTTER_UNITS_TMP_TO_DEVICE ##### -->
 <para>
+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 -&gt; 
+pixel conversion.
 </para>
 
-@x: 
+@x: int
 
 
 <!-- ##### MACRO CLUTTER_UNITS_TO_DEVICE ##### -->
 <para>
-
+Macro for conversion from #ClutterUnit values to device unit (currently 
+pixels).
 </para>
 
-@x: 
+@x: #ClutterUnit
 
 
 <!-- ##### MACRO CLUTTER_UNITS_TO_FIXED ##### -->
 <para>
-
+Macro for conversion of #ClutterUnit value to #ClutterFixed pixel value.
 </para>
 
-@x: 
+@x: #ClutterUnit
 
 
 <!-- ##### MACRO CLUTTER_UNITS_TO_FLOAT ##### -->
 <para>
-
+Macro for conversion of #ClutterUnit value to floating point pixel value.
 </para>
 
-@x: 
+@x: #ClutterUnit
 
 
 <!-- ##### MACRO CLUTTER_UNITS_TO_INT ##### -->
 <para>
-
+Macro for conversion of #ClutterUnit value to int pixel value.
 </para>
 
-@x: 
+@x: #ClutterUnit