2006-12-13 Emmanuele Bassi <ebassi@openedhand.com>

* clutter-sections.txt: Update.

	* tmpl/*.sgml: Update the templates.

doc/reference/ChangeLog

@@ -1,3 +1,9 @@
+2006-12-13  Emmanuele Bassi  <ebassi@openedhand.com>
+
+	* clutter-sections.txt: Update.
+
+	* tmpl/*.sgml: Update the templates.
+
 2006-12-04  Emmanuele Bassi  <ebassi@openedhand.com>
 
 	* clutter-sections.txt: Update with the newly added API.

doc/reference/clutter-sections.txt

@@ -1,6 +1,5 @@
 <SECTION>
 <FILE>clutter-media</FILE>
-CLUTTER_MEDIA_GET_INTERFACE
 ClutterMedia
 ClutterMediaInterface
 clutter_media_set_uri
@@ -19,6 +18,7 @@ clutter_media_set_filename
 CLUTTER_MEDIA
 CLUTTER_IS_MEDIA
 CLUTTER_TYPE_MEDIA
+CLUTTER_MEDIA_GET_INTERFACE
 <SUBSECTION Private>
 clutter_media_get_type
 </SECTION>
@@ -124,6 +124,8 @@ clutter_alpha_get_type
 ClutterCloneTexture
 ClutterCloneTextureClass
 clutter_clone_texture_new
+clutter_clone_texture_get_parent_texture
+clutter_clone_texture_set_parent_texture
 <SUBSECTION Standard>
 CLUTTER_CLONE_TEXTURE
 CLUTTER_IS_CLONE_TEXTURE
@@ -193,8 +195,6 @@ clutter_rectangle_get_type
 
 <SECTION>
 <FILE>clutter-actor</FILE>
-CLUTTER_TYPE_GEOMETRY
-CLUTTER_TYPE_ACTOR_BOX
 CLUTTER_ACTOR_SET_FLAGS
 CLUTTER_ACTOR_UNSET_FLAGS
 CLUTTER_ACTOR_IS_MAPPED
@@ -209,7 +209,9 @@ ClutterCallback
 ClutterActor
 ClutterActorClass
 clutter_actor_show
+clutter_actor_show_all
 clutter_actor_hide
+clutter_actor_hide_all
 clutter_actor_realize
 clutter_actor_unrealize
 clutter_actor_paint
@@ -256,6 +258,8 @@ clutter_actor_get_scalex
 clutter_actor_get_scale
 clutter_actor_get_abs_size
 <SUBSECTION Standard>
+CLUTTER_TYPE_GEOMETRY
+CLUTTER_TYPE_ACTOR_BOX
 CLUTTER_ACTOR
 CLUTTER_IS_ACTOR
 CLUTTER_TYPE_ACTOR
@@ -360,7 +364,6 @@ clutter_timeline_get_type
 <SECTION>
 <FILE>clutter-behaviour-path</FILE>
 <TITLE>ClutterBehaviourPath</TITLE>
-CLUTTER_TYPE_KNOT
 ClutterKnot
 clutter_knot_copy
 clutter_knot_free
@@ -375,6 +378,7 @@ clutter_behaviour_path_insert_knot
 clutter_behaviour_path_remove_knot
 clutter_behaviour_path_clear
 <SUBSECTION Standard>
+CLUTTER_TYPE_KNOT
 CLUTTER_BEHAVIOUR_PATH
 CLUTTER_IS_BEHAVIOUR_PATH
 CLUTTER_TYPE_BEHAVIOUR_PATH
@@ -461,7 +465,6 @@ CLUTTER_FIXED_DIV
 
 <SECTION>
 <FILE>clutter-color</FILE>
-CLUTTER_TYPE_COLOR
 ClutterColor
 clutter_color_parse
 clutter_color_add
@@ -473,6 +476,8 @@ clutter_color_to_hls
 clutter_color_from_hls
 clutter_color_to_pixel
 clutter_color_from_pixel
+<SUBSECTION Standard>
+CLUTTER_TYPE_COLOR
 <SUBSECTION Private>
 clutter_color_get_type
 </SECTION>
@@ -480,7 +485,6 @@ clutter_color_get_type
 <SECTION>
 <FILE>clutter-event</FILE>
 ClutterEventType
-CLUTTER_TYPE_EVENT
 ClutterAnyEvent
 ClutterKeyEvent
 ClutterButtonEvent
@@ -490,15 +494,19 @@ ClutterEvent
 clutter_event_new
 clutter_event_copy
 clutter_event_free
+clutter_event_type
 clutter_key_event_type
 clutter_key_event_time
 clutter_key_event_state
+clutter_button_event_time
 clutter_button_event_x
 clutter_button_event_y
 clutter_key_event_symbol
 clutter_key_event_code
 clutter_key_event_unicode
 clutter_keysym_to_unicode
+<SUBSECTION Standard>
+CLUTTER_TYPE_EVENT
 <SUBSECTION Private>
 clutter_event_get_type
 </SECTION>

doc/reference/tmpl/clutter-actor.sgml

@@ -17,114 +17,102 @@ ClutterActor
 <!-- ##### SECTION Stability_Level ##### -->
 
 
-<!-- ##### MACRO CLUTTER_TYPE_GEOMETRY ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO CLUTTER_TYPE_ACTOR_BOX ##### -->
-<para>
-
-</para>
-
-
-
 <!-- ##### MACRO CLUTTER_ACTOR_SET_FLAGS ##### -->
 <para>
-
+Sets a flag from #ClutterActorFlags to an actor
 </para>
 
-@e: 
+@e: a #ClutterActor 
-@f: 
+@f: the flag to set
 
 
 <!-- ##### MACRO CLUTTER_ACTOR_UNSET_FLAGS ##### -->
 <para>
-
+Unsets a flag from #ClutterActorFlags to an actor
 </para>
 
-@e: 
+@e: a #ClutterActor
-@f: 
+@f: the flag to unset
 
 
 <!-- ##### MACRO CLUTTER_ACTOR_IS_MAPPED ##### -->
 <para>
-
+Evaluates to %TRUE if an actor is mapped.
 </para>
 
-@e: 
+@e: a #ClutterActor
 
 
 <!-- ##### MACRO CLUTTER_ACTOR_IS_REALIZED ##### -->
 <para>
-
+Evaluates to %TRUE if an actor has been realized.
 </para>
 
-@e: 
+@e: a #ClutterActor
 
 
 <!-- ##### MACRO CLUTTER_ACTOR_IS_VISIBLE ##### -->
 <para>
-
+Evaluates to %TRUE if an actor is visible.
 </para>
 
-@e: 
+@e: a #ClutterActor
 
 
 <!-- ##### STRUCT ClutterActorBox ##### -->
 <para>
-
+Coordinates (top-left to bottom-right) of a box surrounding an actor.
 </para>
 
-@x1: 
+@x1: X coordinate of the top left corner of the box
-@y1: 
+@y1: Y coordinate of the top left corner of the box
-@x2: 
+@x2: X coordinate of the bottom right corner of the box
-@y2: 
+@y2: Y coordinate of the bottom right corner of the box
 
 <!-- ##### ENUM ClutterActorFlags ##### -->
 <para>
-
+Flags used by an actor.
 </para>
 
-@CLUTTER_ACTOR_MAPPED: 
+@CLUTTER_ACTOR_MAPPED: the actor is mapped
-@CLUTTER_ACTOR_REALIZED: 
+@CLUTTER_ACTOR_REALIZED: the actor is realised
 
 <!-- ##### STRUCT ClutterGeometry ##### -->
 <para>
-
+Positional and dimensional coordinates of an actor.
 </para>
 
-@x: 
+@x: X coordinate of the top left corner of an actor
-@y: 
+@y: Y coordinate of the top left corner of an actor
-@width: 
+@width: width of an actor
-@height: 
+@height: height of an actor
 
 <!-- ##### MACRO CLUTTER_CALLBACK ##### -->
 <para>
-
+Casts a generic callback function into a #ClutterCallback
 </para>
 
-@f: 
+@f: a function pointer
 
 
 <!-- ##### USER_FUNCTION ClutterCallback ##### -->
 <para>
-
+Generic callback function.
 </para>
 
-@actor: 
+@actor: a #ClutterActor
-@data: 
+@data: optional data to be passed to the function
 
 
 <!-- ##### STRUCT ClutterActor ##### -->
 <para>
-
+Basic element of the Clutter canvas.  Every object present on the stage must
+be an actor.  You can scale, move and rotate an actor; you can group actors
+inside #ClutterGroup<!-- -->s or let them follow a #ClutterBehaviour.
 </para>
 
-@parent_instance: 
+@parent_instance: parent class
-@flags: 
+@flags: flags set for the actor
 
 <!-- ##### SIGNAL ClutterActor::destroy ##### -->
 <para>
@@ -202,10 +190,10 @@ ClutterActor
 
 <!-- ##### STRUCT ClutterActorClass ##### -->
 <para>
-
+Base class for #ClutterActor
 </para>
 
-@parent_class: 
+@parent_class: parent class
 @show: 
 @show_all: 
 @hide: 
@@ -235,6 +223,14 @@ ClutterActor
 @self: 
 
 
+<!-- ##### FUNCTION clutter_actor_show_all ##### -->
+<para>
+
+</para>
+
+@self: 
+
+
 <!-- ##### FUNCTION clutter_actor_hide ##### -->
 <para>
 
@@ -243,6 +239,14 @@ ClutterActor
 @self: 
 
 
+<!-- ##### FUNCTION clutter_actor_hide_all ##### -->
+<para>
+
+</para>
+
+@self: 
+
+
 <!-- ##### FUNCTION clutter_actor_realize ##### -->
 <para>
 

doc/reference/tmpl/clutter-alpha.sgml

@@ -77,19 +77,21 @@ accessed directly.
 
 <!-- ##### MACRO CLUTTER_ALPHA_MAX_ALPHA ##### -->
 <para>
-
+Maximum value of the alpha function.  You should use this value to
+scale the computed alpha value.
 </para>
 
 
 
 <!-- ##### USER_FUNCTION ClutterAlphaFunc ##### -->
 <para>
-
+The alpha function is a function of time.  You should provide a function
+transforming the current position in the timeline.
 </para>
 
-@alpha: 
+@alpha: a #ClutterAlpha
-@user_data: 
+@user_data: optional user defined data passed to the function
-@Returns: 
+@Returns: a value between 0 and CLUTTER_ALPHA_MAX_ALPHA
 
 
 <!-- ##### FUNCTION clutter_alpha_set_func ##### -->
@@ -123,7 +125,7 @@ accessed directly.
 
 <!-- ##### MACRO CLUTTER_ALPHA_RAMP_INC ##### -->
 <para>
-
+Symbolic name for passing clutter_ramp_inc_func().
 </para>
 
 
@@ -140,7 +142,7 @@ accessed directly.
 
 <!-- ##### MACRO CLUTTER_ALPHA_RAMP_DEC ##### -->
 <para>
-
+Symbolic name for passing clutter_ramp_dec_func().
 </para>
 
 
@@ -157,7 +159,7 @@ accessed directly.
 
 <!-- ##### MACRO CLUTTER_ALPHA_RAMP ##### -->
 <para>
-
+Symbolic name for passing clutter_ramp_func().
 </para>
 
 
@@ -174,7 +176,7 @@ accessed directly.
 
 <!-- ##### MACRO CLUTTER_ALPHA_SINE ##### -->
 <para>
-
+Symbolic name for passing clutter_sine_func().
 </para>
 
 

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

@@ -19,7 +19,8 @@ ClutterBehaviourOpacity
 
 <!-- ##### STRUCT ClutterBehaviourOpacity ##### -->
 <para>
-
+The <structname>ClutterBehaviourOpacity</structname> struct has only
+private data and should not be accessed directly.
 </para>
 
 
@@ -35,7 +36,7 @@ ClutterBehaviourOpacity
 
 <!-- ##### STRUCT ClutterBehaviourOpacityClass ##### -->
 <para>
-
+Class structure for #ClutterBehaviourOpacity.
 </para>
 
 @parent_class: 

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

@@ -17,20 +17,13 @@ ClutterBehaviourPath
 <!-- ##### SECTION Stability_Level ##### -->
 
 
-<!-- ##### MACRO CLUTTER_TYPE_KNOT ##### -->
-<para>
-
-</para>
-
-
-
 <!-- ##### STRUCT ClutterKnot ##### -->
 <para>
-
+A single node of the path followed by a #ClutterBehaviourPath.
 </para>
 
-@x: 
+@x: X coordinate of the node
-@y: 
+@y: Y coordinate of the node
 
 <!-- ##### FUNCTION clutter_knot_copy ##### -->
 <para>
@@ -61,7 +54,8 @@ ClutterBehaviourPath
 
 <!-- ##### STRUCT ClutterBehaviourPath ##### -->
 <para>
-
+The <structname>ClutterBehaviourPath</structname> structure contains
+only private data, and should not be accessed directly.
 </para>
 
 
@@ -80,7 +74,7 @@ ClutterBehaviourPath
 
 <!-- ##### STRUCT ClutterBehaviourPathClass ##### -->
 <para>
-
+Class structure for #ClutterBehaviourPath.
 </para>
 
 @parent_class: 

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

@@ -19,7 +19,7 @@ ClutterBehaviourScale
 
 <!-- ##### ENUM ClutterGravity ##### -->
 <para>
-
+Defines the reference point of the scaling.
 </para>
 
 @CLUTTER_GRAVITY_NONE: 
@@ -31,11 +31,12 @@ ClutterBehaviourScale
 @CLUTTER_GRAVITY_SOUTH_WEST: 
 @CLUTTER_GRAVITY_WEST: 
 @CLUTTER_GRAVITY_NORTH_WEST: 
-@CLUTTER_GRAVITY_CENTER: 
+@CLUTTER_GRAVITY_CENTER: the actor should scale from the center
 
 <!-- ##### STRUCT ClutterBehaviourScale ##### -->
 <para>
-
+The <structname>ClutterBehaviourScale</structname> structure contains only
+private data and should not be accessed directly.
 </para>
 
 
@@ -56,7 +57,7 @@ ClutterBehaviourScale
 
 <!-- ##### STRUCT ClutterBehaviourScaleClass ##### -->
 <para>
-
+Class structure for #ClutterBehaviourScale.
 </para>
 
 @parent_class: 

doc/reference/tmpl/clutter-behaviour.sgml

@@ -30,11 +30,15 @@ ClutterBehaviour
 
 <!-- ##### STRUCT ClutterBehaviourClass ##### -->
 <para>
-
+Class structure.
 </para>
 
-@parent_class: 
+@parent_class: parent class
-@alpha_notify: 
+@alpha_notify: Override this virtual function when creating a new behaviour.
+  The alpha notify virtual function is called each time the alpha value
+  computed by the #ClutterAlpha object changes; in this virtual function
+  you should update the properties driven by your behaviour for all the
+  actors to which the behaviour applies.
 @_clutter_behaviour1: 
 @_clutter_behaviour2: 
 @_clutter_behaviour3: 
@@ -62,12 +66,13 @@ ClutterBehaviour
 
 <!-- ##### USER_FUNCTION ClutterBehaviourForeachFunc ##### -->
 <para>
-
+The function used to iterate on every #ClutterActor to which a behaviour
+applies.
 </para>
 
-@behaviour: 
+@behaviour: a #ClutterBehaviour
-@actor: 
+@actor: a #ClutterActor
-@data: 
+@data: optional user data passed to this function
 
 
 <!-- ##### FUNCTION clutter_behaviour_actors_foreach ##### -->

doc/reference/tmpl/clutter-clone-texture.sgml

@@ -48,3 +48,21 @@ ClutterCloneTexture
 @Returns: 
 
 
+<!-- ##### FUNCTION clutter_clone_texture_get_parent_texture ##### -->
+<para>
+
+</para>
+
+@clone: 
+@Returns: 
+
+
+<!-- ##### FUNCTION clutter_clone_texture_set_parent_texture ##### -->
+<para>
+
+</para>
+
+@clone: 
+@texture: 
+
+

doc/reference/tmpl/clutter-color.sgml

@@ -17,13 +17,6 @@ clutter-color
 <!-- ##### SECTION Stability_Level ##### -->
 
 
-<!-- ##### MACRO CLUTTER_TYPE_COLOR ##### -->
-<para>
-
-</para>
-
-
-
 <!-- ##### STRUCT ClutterColor ##### -->
 <para>
 

doc/reference/tmpl/clutter-event.sgml

@@ -30,13 +30,6 @@ Windowing events handled by Clutter.
 @CLUTTER_2BUTTON_PRESS: 
 @CLUTTER_BUTTON_RELEASE: 
 
-<!-- ##### MACRO CLUTTER_TYPE_EVENT ##### -->
-<para>
-
-</para>
-
-
-
 <!-- ##### STRUCT ClutterAnyEvent ##### -->
 <para>
 
@@ -120,6 +113,15 @@ Windowing events handled by Clutter.
 @event: 
 
 
+<!-- ##### FUNCTION clutter_event_type ##### -->
+<para>
+
+</para>
+
+@event: 
+@Returns: 
+
+
 <!-- ##### FUNCTION clutter_key_event_time ##### -->
 <para>
 
@@ -138,6 +140,15 @@ Windowing events handled by Clutter.
 @Returns: 
 
 
+<!-- ##### FUNCTION clutter_button_event_time ##### -->
+<para>
+
+</para>
+
+@buttev: 
+@Returns: 
+
+
 <!-- ##### FUNCTION clutter_button_event_x ##### -->
 <para>
 

doc/reference/tmpl/clutter-main.sgml

@@ -19,22 +19,22 @@ clutter-main
 
 <!-- ##### MACRO CLUTTER_INIT_ERROR ##### -->
 <para>
-
+GError domain for the #ClutterInitError enum.
 </para>
 
 
 
 <!-- ##### ENUM ClutterInitError ##### -->
 <para>
-
+Error codes for the Clutter initialisation process.
 </para>
 
-@CLUTTER_INIT_SUCCESS: 
+@CLUTTER_INIT_SUCCESS: Clutter was successfully initialised
-@CLUTTER_INIT_ERROR_UNKOWN: 
+@CLUTTER_INIT_ERROR_UNKOWN: Unknown error while initialising Clutter
-@CLUTTER_INIT_ERROR_THREADS: 
+@CLUTTER_INIT_ERROR_THREADS: Unable to initialise threading
-@CLUTTER_INIT_ERROR_DISPLAY: 
+@CLUTTER_INIT_ERROR_DISPLAY: Unable to open the X display
-@CLUTTER_INIT_ERROR_INTERNAL: 
+@CLUTTER_INIT_ERROR_INTERNAL: Internal Clutter error
-@CLUTTER_INIT_ERROR_OPENGL: 
+@CLUTTER_INIT_ERROR_OPENGL: Unable to initialise OpenGL
 
 <!-- ##### FUNCTION clutter_init ##### -->
 <para>

doc/reference/tmpl/clutter-media.sgml

@@ -17,14 +17,6 @@ clutter-media
 <!-- ##### SECTION Stability_Level ##### -->
 
 
-<!-- ##### MACRO CLUTTER_MEDIA_GET_INTERFACE ##### -->
-<para>
-
-</para>
-
-@obj: 
-
-
 <!-- ##### STRUCT ClutterMedia ##### -->
 <para>
 

doc/reference/tmpl/clutter-stage.sgml

@@ -19,14 +19,14 @@ ClutterStage
 
 <!-- ##### MACRO CLUTTER_STAGE_WIDTH ##### -->
 <para>
-
+Macro evaluating to the width of the #ClutterStage
 </para>
 
 
 
 <!-- ##### MACRO CLUTTER_STAGE_HEIGHT ##### -->
 <para>
-
+Macro evaluating to the height of the #ClutterStage
 </para>