summaryrefslogtreecommitdiff
path: root/clutter
diff options
context:
space:
mode:
authorEmmanuele Bassi <ebassi@linux.intel.com>2011-07-26 13:43:37 +0100
committerEmmanuele Bassi <ebassi@linux.intel.com>2011-07-26 13:44:12 +0100
commit78049c38bf1839b9982059540501a9e3ef5e0c81 (patch)
tree469b7814aa0a92f68778d007d55ea430dd354645 /clutter
parent278daca61cbeaffbf5515f7d105ff168b33a3be1 (diff)
downloadclutter-78049c38bf1839b9982059540501a9e3ef5e0c81.tar.gz
docs: Fixes for building the API reference
Diffstat (limited to 'clutter')
-rw-r--r--clutter/clutter-actor.c6
-rw-r--r--clutter/clutter-animation.c6
-rw-r--r--clutter/clutter-animator.c2
-rw-r--r--clutter/clutter-box.c8
-rw-r--r--clutter/clutter-cairo-texture.c2
-rw-r--r--clutter/clutter-cairo-texture.h1
-rw-r--r--clutter/clutter-container.c4
-rw-r--r--clutter/clutter-interval.c6
-rw-r--r--clutter/clutter-layout-manager.c4
-rw-r--r--clutter/clutter-list-model.c2
-rw-r--r--clutter/clutter-model.c10
-rw-r--r--clutter/clutter-paint-volume.c27
-rw-r--r--clutter/clutter-script.c2
-rw-r--r--clutter/clutter-shader-effect.c2
-rw-r--r--clutter/clutter-state.c2
15 files changed, 41 insertions, 43 deletions
diff --git a/clutter/clutter-actor.c b/clutter/clutter-actor.c
index 55f1fdd80..4855ed647 100644
--- a/clutter/clutter-actor.c
+++ b/clutter/clutter-actor.c
@@ -2119,10 +2119,10 @@ clutter_actor_apply_transform_to_point (ClutterActor *self,
* using cogl_set_modelview_matrix() for example then you would want a matrix
* that transforms into eye coordinates.
*
- * <note>This function explicitly initializes the given @matrix. If you just
+ * <note><para>This function explicitly initializes the given @matrix. If you just
* want clutter to multiply a relative transformation with an existing matrix
- * you can use clutter_actor_apply_relative_transformation_matrix() instead.
- * </note>
+ * you can use clutter_actor_apply_relative_transformation_matrix()
+ * instead.</para></note>
*
*/
/* XXX: We should consider caching the stage relative modelview along with
diff --git a/clutter/clutter-animation.c b/clutter/clutter-animation.c
index f284c5191..80c5bc835 100644
--- a/clutter/clutter-animation.c
+++ b/clutter/clutter-animation.c
@@ -2007,7 +2007,7 @@ animation_create_for_actor (ClutterActor *actor)
* @actor: a #ClutterActor
* @alpha: a #ClutterAlpha
* @first_property_name: the name of a property
- * @Varargs: a %NULL terminated list of property names and
+ * @...: a %NULL terminated list of property names and
* property values
*
* Animates the given list of properties of @actor between the current
@@ -2064,7 +2064,7 @@ clutter_actor_animate_with_alpha (ClutterActor *actor,
* @mode: an animation mode logical id
* @timeline: a #ClutterTimeline
* @first_property_name: the name of a property
- * @Varargs: a %NULL terminated list of property names and
+ * @...: a %NULL terminated list of property names and
* property values
*
* Animates the given list of properties of @actor between the current
@@ -2115,7 +2115,7 @@ clutter_actor_animate_with_timeline (ClutterActor *actor,
* @mode: an animation mode logical id
* @duration: duration of the animation, in milliseconds
* @first_property_name: the name of a property
- * @Varargs: a %NULL terminated list of property names and
+ * @...: a %NULL terminated list of property names and
* property values
*
* Animates the given list of properties of @actor between the current
diff --git a/clutter/clutter-animator.c b/clutter/clutter-animator.c
index d26e3050a..61715e83f 100644
--- a/clutter/clutter-animator.c
+++ b/clutter/clutter-animator.c
@@ -1161,7 +1161,7 @@ clutter_animator_get_duration (ClutterAnimator *animator)
* @first_mode: the id of the alpha function to use
* @first_progress: at which stage of the animation this value applies; the
* range is a normalized floating point value between 0 and 1
- * @Varargs: the value first_property_name should have for first_object
+ * @...: the value first_property_name should have for first_object
* at first_progress, followed by more (object, property_name, mode,
* progress, value) tuples, followed by %NULL
*
diff --git a/clutter/clutter-box.c b/clutter/clutter-box.c
index 0d922b1de..26d7696be 100644
--- a/clutter/clutter-box.c
+++ b/clutter/clutter-box.c
@@ -807,7 +807,7 @@ clutter_box_set_property_valist (ClutterBox *box,
* @box: a #ClutterBox
* @actor: a #ClutterActor
* @first_property: the name of the first property to set, or %NULL
- * @Varargs: a list of property name and value pairs, terminated by %NULL
+ * @...: a list of property name and value pairs, terminated by %NULL
*
* Adds @actor to @box and sets layout properties at the same time,
* if the #ClutterLayoutManager used by @box has them
@@ -847,7 +847,7 @@ clutter_box_pack (ClutterBox *box,
* @actor: a #ClutterActor
* @sibling: (allow-none): a #ClutterActor or %NULL
* @first_property: the name of the first property to set, or %NULL
- * @Varargs: a list of property name and value pairs, terminated by %NULL
+ * @...: a list of property name and value pairs, terminated by %NULL
*
* Adds @actor to @box, placing it after @sibling, and sets layout
* properties at the same time, if the #ClutterLayoutManager used by
@@ -891,7 +891,7 @@ clutter_box_pack_after (ClutterBox *box,
* @actor: a #ClutterActor
* @sibling: (allow-none): a #ClutterActor or %NULL
* @first_property: the name of the first property to set, or %NULL
- * @Varargs: a list of property name and value pairs, terminated by %NULL
+ * @...: a list of property name and value pairs, terminated by %NULL
*
* Adds @actor to @box, placing it before @sibling, and sets layout
* properties at the same time, if the #ClutterLayoutManager used by
@@ -935,7 +935,7 @@ clutter_box_pack_before (ClutterBox *box,
* @actor: a #ClutterActor
* @position: the position to insert the @actor at
* @first_property: the name of the first property to set, or %NULL
- * @Varargs: a list of property name and value pairs, terminated by %NULL
+ * @...: a list of property name and value pairs, terminated by %NULL
*
* Adds @actor to @box, placing it at @position, and sets layout
* properties at the same time, if the #ClutterLayoutManager used by
diff --git a/clutter/clutter-cairo-texture.c b/clutter/clutter-cairo-texture.c
index d1bac414f..f5ec31030 100644
--- a/clutter/clutter-cairo-texture.c
+++ b/clutter/clutter-cairo-texture.c
@@ -594,7 +594,7 @@ clutter_cairo_texture_class_init (ClutterCairoTextureClass *klass)
/**
* ClutterCairoTexture::draw:
- * @self: the #ClutterCairoTexture that emitted the signal
+ * @texture: the #ClutterCairoTexture that emitted the signal
* @cr: the Cairo context to use to draw
*
* The ::draw signal is emitted each time a #ClutterCairoTexture has
diff --git a/clutter/clutter-cairo-texture.h b/clutter/clutter-cairo-texture.h
index cf163ce14..4126a62cb 100644
--- a/clutter/clutter-cairo-texture.h
+++ b/clutter/clutter-cairo-texture.h
@@ -87,6 +87,7 @@ struct _ClutterCairoTexture
* ClutterCairoTextureClass:
* @create_surface: class handler for the #ClutterCairoTexture::create-surface
* signal
+ * @draw: class handler for the #ClutterCairoTexture::draw signal
*
* The #ClutterCairoTextureClass struct contains only private data.
*
diff --git a/clutter/clutter-container.c b/clutter/clutter-container.c
index 760f6c6ea..11776c10f 100644
--- a/clutter/clutter-container.c
+++ b/clutter/clutter-container.c
@@ -180,7 +180,7 @@ clutter_container_default_init (ClutterContainerInterface *iface)
* clutter_container_add: (skip)
* @container: a #ClutterContainer
* @first_actor: the first #ClutterActor to add
- * @Varargs: %NULL terminated list of actors to add
+ * @...: %NULL terminated list of actors to add
*
* Adds a list of #ClutterActor<!-- -->s to @container. Each time and
* actor is added, the "actor-added" signal is emitted. Each actor should
@@ -284,7 +284,7 @@ clutter_container_add_valist (ClutterContainer *container,
* clutter_container_remove: (skip)
* @container: a #ClutterContainer
* @first_actor: first #ClutterActor to remove
- * @Varargs: a %NULL-terminated list of actors to remove
+ * @...: a %NULL-terminated list of actors to remove
*
* Removes a %NULL terminated list of #ClutterActor<!-- -->s from
* @container. Each actor should be unparented, so if you want to keep it
diff --git a/clutter/clutter-interval.c b/clutter/clutter-interval.c
index 2ae3c1c5f..c15123168 100644
--- a/clutter/clutter-interval.c
+++ b/clutter/clutter-interval.c
@@ -495,7 +495,7 @@ clutter_interval_get_interval_valist (ClutterInterval *interval,
/**
* clutter_interval_new:
* @gtype: the type of the values in the interval
- * @Varargs: the initial value and the final value of the interval
+ * @...: the initial value and the final value of the interval
*
* Creates a new #ClutterInterval holding values of type @gtype.
*
@@ -785,7 +785,7 @@ clutter_interval_peek_final_value (ClutterInterval *interval)
/**
* clutter_interval_set_interval:
* @interval: a #ClutterInterval
- * @Varargs: the initial and final values of the interval
+ * @...: the initial and final values of the interval
*
* Variable arguments wrapper for clutter_interval_set_initial_value()
* and clutter_interval_set_final_value() that avoids using the
@@ -819,7 +819,7 @@ clutter_interval_set_interval (ClutterInterval *interval,
/**
* clutter_interval_get_interval:
* @interval: a #ClutterInterval
- * @Varargs: return locations for the initial and final values of
+ * @...: return locations for the initial and final values of
* the interval
*
* Variable arguments wrapper for clutter_interval_get_initial_value()
diff --git a/clutter/clutter-layout-manager.c b/clutter/clutter-layout-manager.c
index 2536763fb..9f17f52b2 100644
--- a/clutter/clutter-layout-manager.c
+++ b/clutter/clutter-layout-manager.c
@@ -896,7 +896,7 @@ layout_get_property_internal (ClutterLayoutManager *manager,
* @container: a #ClutterContainer using @manager
* @actor: a #ClutterActor child of @container
* @first_property: the first property name
- * @Varargs: a list of property name and value pairs
+ * @...: a list of property name and value pairs
*
* Sets a list of properties and their values on the #ClutterLayoutMeta
* associated by @manager to a child of @container
@@ -1038,7 +1038,7 @@ clutter_layout_manager_child_set_property (ClutterLayoutManager *manager,
* @container: a #ClutterContainer using @manager
* @actor: a #ClutterActor child of @container
* @first_property: the name of the first property
- * @Varargs: a list of property name and return location for the value pairs
+ * @...: a list of property name and return location for the value pairs
*
* Retrieves the values for a list of properties out of the
* #ClutterLayoutMeta created by @manager and attached to the
diff --git a/clutter/clutter-list-model.c b/clutter/clutter-list-model.c
index cfd98560a..d7a98e2fd 100644
--- a/clutter/clutter-list-model.c
+++ b/clutter/clutter-list-model.c
@@ -718,7 +718,7 @@ clutter_list_model_init (ClutterListModel *model)
/**
* clutter_list_model_new:
* @n_columns: number of columns in the model
- * @Varargs: @n_columns number of #GType and string pairs
+ * @...: @n_columns number of #GType and string pairs
*
* Creates a new default model with @n_columns columns with the types
* and names passed in.
diff --git a/clutter/clutter-model.c b/clutter/clutter-model.c
index 644e55ecd..17fcb057f 100644
--- a/clutter/clutter-model.c
+++ b/clutter/clutter-model.c
@@ -1074,7 +1074,7 @@ static void clutter_model_iter_set_internal_valist (ClutterModelIter *iter,
/**
* clutter_model_append:
* @model: a #ClutterModel
- * @Varargs: pairs of column number and value, terminated with -1
+ * @...: pairs of column number and value, terminated with -1
*
* Creates and appends a new row to the #ClutterModel, setting the
* row values upon creation. For example, to append a new row where
@@ -1164,7 +1164,7 @@ clutter_model_prependv (ClutterModel *model,
/**
* clutter_model_prepend:
* @model: a #ClutterModel
- * @Varargs: pairs of column number and value, terminated with -1
+ * @...: pairs of column number and value, terminated with -1
*
* Creates and prepends a new row to the #ClutterModel, setting the row
* values upon creation. For example, to prepend a new row where column 0
@@ -1206,7 +1206,7 @@ clutter_model_prepend (ClutterModel *model,
* clutter_model_insert:
* @model: a #ClutterModel
* @row: the position to insert the new row
- * @Varargs: pairs of column number and value, terminated with -1
+ * @...: pairs of column number and value, terminated with -1
*
* Inserts a new row to the #ClutterModel at @row, setting the row
* values upon creation. For example, to insert a new row at index 100,
@@ -2068,7 +2068,7 @@ clutter_model_iter_set_valist (ClutterModelIter *iter,
/**
* clutter_model_iter_get:
* @iter: a #ClutterModelIter
- * @Varargs: a list of column/return location pairs, terminated by -1
+ * @...: a list of column/return location pairs, terminated by -1
*
* Gets the value of one or more cells in the row referenced by @iter. The
* variable argument list should contain integer column numbers, each column
@@ -2191,7 +2191,7 @@ clutter_model_iter_get_valist (ClutterModelIter *iter,
/**
* clutter_model_iter_set:
* @iter: a #ClutterModelIter
- * @Varargs: a list of column/return location pairs, terminated by -1
+ * @...: a list of column/return location pairs, terminated by -1
*
* Sets the value of one or more cells in the row referenced by @iter. The
* variable argument list should contain integer column numbers, each column
diff --git a/clutter/clutter-paint-volume.c b/clutter/clutter-paint-volume.c
index 611d57f0d..24ea8da9e 100644
--- a/clutter/clutter-paint-volume.c
+++ b/clutter/clutter-paint-volume.c
@@ -290,16 +290,15 @@ clutter_paint_volume_set_width (ClutterPaintVolume *pv,
* around the volume. It returns the size of that bounding box as
* measured along the x-axis.
*
- * <note>If, for example, clutter_actor_get_transformed_paint_volume()
+ * <note><para>If, for example, clutter_actor_get_transformed_paint_volume()
* is used to transform a 2D child actor that is 100px wide, 100px
* high and 0px deep into container coordinates then the width might
* not simply be 100px if the child actor has a 3D rotation applied to
- * it.
- *
- * Remember; after clutter_actor_get_transformed_paint_volume() is
+ * it.</para>
+ * <para>Remember; after clutter_actor_get_transformed_paint_volume() is
* used then a transformed child volume will be defined relative to the
* ancestor container actor and so a 2D child actor
- * can have a 3D bounding volume.</note>
+ * can have a 3D bounding volume.</para></note>
*
* <note>There are no accuracy guarantees for the reported width,
* except that it must always be >= to the true width. This is
@@ -382,16 +381,15 @@ clutter_paint_volume_set_height (ClutterPaintVolume *pv,
* around the volume. It returns the size of that bounding box as
* measured along the y-axis.
*
- * <note>If, for example, clutter_actor_get_transformed_paint_volume()
+ * <note><para>If, for example, clutter_actor_get_transformed_paint_volume()
* is used to transform a 2D child actor that is 100px wide, 100px
* high and 0px deep into container coordinates then the height might
* not simply be 100px if the child actor has a 3D rotation applied to
- * it.
- *
- * Remember; after clutter_actor_get_transformed_paint_volume() is
+ * it.</para>
+ * <para>Remember; after clutter_actor_get_transformed_paint_volume() is
* used then a transformed child volume will be defined relative to the
* ancestor container actor and so a 2D child actor
- * can have a 3D bounding volume.</note>
+ * can have a 3D bounding volume.</para></note>
*
* <note>There are no accuracy guarantees for the reported height,
* except that it must always be >= to the true height. This is
@@ -475,16 +473,15 @@ clutter_paint_volume_set_depth (ClutterPaintVolume *pv,
* around the volume. It returns the size of that bounding box as
* measured along the z-axis.
*
- * <note>If, for example, clutter_actor_get_transformed_paint_volume()
+ * <note><para>If, for example, clutter_actor_get_transformed_paint_volume()
* is used to transform a 2D child actor that is 100px wide, 100px
* high and 0px deep into container coordinates then the depth might
* not simply be 0px if the child actor has a 3D rotation applied to
- * it.
- *
- * Remember; after clutter_actor_get_transformed_paint_volume() is
+ * it.</para>
+ * <para>Remember; after clutter_actor_get_transformed_paint_volume() is
* used then the transformed volume will be defined relative to the
* container actor and in container coordinates a 2D child actor
- * can have a 3D bounding volume.</note>
+ * can have a 3D bounding volume.</para></note>
*
* <note>There are no accuracy guarantees for the reported depth,
* except that it must always be >= to the true depth. This is
diff --git a/clutter/clutter-script.c b/clutter/clutter-script.c
index b3625c037..b964b7a54 100644
--- a/clutter/clutter-script.c
+++ b/clutter/clutter-script.c
@@ -661,7 +661,7 @@ clutter_script_get_objects_valist (ClutterScript *script,
* clutter_script_get_objects:
* @script: a #ClutterScript
* @first_name: the name of the first object to retrieve
- * @Varargs: return location for a #GObject, then additional names, ending
+ * @...: return location for a #GObject, then additional names, ending
* with %NULL
*
* Retrieves a list of objects for the given names. After @script, object
diff --git a/clutter/clutter-shader-effect.c b/clutter/clutter-shader-effect.c
index ccb8082dd..0b0850985 100644
--- a/clutter/clutter-shader-effect.c
+++ b/clutter/clutter-shader-effect.c
@@ -727,7 +727,7 @@ add_uniform:
* @name: the name of the uniform to set
* @gtype: the type of the uniform to set
* @n_values: the number of values
- * @Varargs: a list of values
+ * @...: a list of values
*
* Sets a list of values as the payload for the uniform @name inside
* the shader effect
diff --git a/clutter/clutter-state.c b/clutter/clutter-state.c
index b1e652271..597e58966 100644
--- a/clutter/clutter-state.c
+++ b/clutter/clutter-state.c
@@ -847,7 +847,7 @@ get_property_from_object (GObject *gobject,
* @first_object: a #GObject
* @first_property_name: a property of @first_object to specify a key for
* @first_mode: the id of the alpha function to use
- * @Varargs: the value @first_property_name should have in @target_state_name,
+ * @...: the value @first_property_name should have in @target_state_name,
* followed by object, property name, mode, value tuples, terminated
* by %NULL
*