brl/mutter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Don't use '::' to denote an object property

Browse Source 
That's actually for signals in gtk-doc and we're not dealing with
GObjects so it's not really appropriate. Used <structfield> as it's the
closest tag I could find to describe a 'property' of a CoglObject and
gives a generic style in the produced HTML.

(cherry picked from commit 8b485d57577cff227a0c7a2e6c06d8d277821374)
This commit is contained in:
Damien Lespiau 2012-12-31 16:12:03 +00:00 committed by Robert Bragg
parent 780b01f1c8
commit 55d2a039c6
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
cogl/cogl-primitive.h
View File

@ -217,7 +217,7 @@ typedef struct {
* drawn later with no addition information required. * drawn later with no addition information required.
* *
* The value passed as @n_vertices will simply update the * The value passed as @n_vertices will simply update the
* #CoglPrimitive::n_vertices property as if * #CoglPrimitive <structfield>n_vertices</structfield> property as if
* cogl_primitive_set_n_vertices() were called. This property defines * cogl_primitive_set_n_vertices() were called. This property defines
* the number of vertices to read when drawing. * the number of vertices to read when drawing.
* *
@ -265,7 +265,7 @@ cogl_primitive_new_with_attributes (CoglVerticesMode mode,
* *
* The value passed as @n_vertices is initially used to determine how * The value passed as @n_vertices is initially used to determine how
* much can be read from @data but it will also be used to update the * much can be read from @data but it will also be used to update the
* #CoglPrimitive::n_vertices property as if * #CoglPrimitive <structfield>n_vertices</structfield> property as if
* cogl_primitive_set_n_vertices() were called. This property defines * cogl_primitive_set_n_vertices() were called. This property defines
* the number of vertices to read when drawing. * the number of vertices to read when drawing.
@ -318,7 +318,7 @@ cogl_primitive_new_p2 (CoglContext *context,
* *
* The value passed as @n_vertices is initially used to determine how * The value passed as @n_vertices is initially used to determine how
* much can be read from @data but it will also be used to update the * much can be read from @data but it will also be used to update the
* #CoglPrimitive::n_vertices property as if * #CoglPrimitive <structfield>n_vertices</structfield> property as if
* cogl_primitive_set_n_vertices() were called. This property defines * cogl_primitive_set_n_vertices() were called. This property defines
* the number of vertices to read when drawing. * the number of vertices to read when drawing.
@ -373,7 +373,7 @@ cogl_primitive_new_p3 (CoglContext *context,
* *
* The value passed as @n_vertices is initially used to determine how * The value passed as @n_vertices is initially used to determine how
* much can be read from @data but it will also be used to update the * much can be read from @data but it will also be used to update the
* #CoglPrimitive::n_vertices property as if * #CoglPrimitive <structfield>n_vertices</structfield> property as if
* cogl_primitive_set_n_vertices() were called. This property defines * cogl_primitive_set_n_vertices() were called. This property defines
* the number of vertices to read when drawing. * the number of vertices to read when drawing.
@ -428,7 +428,7 @@ cogl_primitive_new_p2c4 (CoglContext *context,
* *
* The value passed as @n_vertices is initially used to determine how * The value passed as @n_vertices is initially used to determine how
* much can be read from @data but it will also be used to update the * much can be read from @data but it will also be used to update the
* #CoglPrimitive::n_vertices property as if * #CoglPrimitive <structfield>n_vertices</structfield> property as if
* cogl_primitive_set_n_vertices() were called. This property defines * cogl_primitive_set_n_vertices() were called. This property defines
* the number of vertices to read when drawing. * the number of vertices to read when drawing.
@ -483,7 +483,7 @@ cogl_primitive_new_p3c4 (CoglContext *context,
* *
* The value passed as @n_vertices is initially used to determine how * The value passed as @n_vertices is initially used to determine how
* much can be read from @data but it will also be used to update the * much can be read from @data but it will also be used to update the
* #CoglPrimitive::n_vertices property as if * #CoglPrimitive <structfield>n_vertices</structfield> property as if
* cogl_primitive_set_n_vertices() were called. This property defines * cogl_primitive_set_n_vertices() were called. This property defines
* the number of vertices to read when drawing. * the number of vertices to read when drawing.
@ -538,7 +538,7 @@ cogl_primitive_new_p2t2 (CoglContext *context,
* *
* The value passed as @n_vertices is initially used to determine how * The value passed as @n_vertices is initially used to determine how
* much can be read from @data but it will also be used to update the * much can be read from @data but it will also be used to update the
* #CoglPrimitive::n_vertices property as if * #CoglPrimitive <structfield>n_vertices</structfield> property as if
* cogl_primitive_set_n_vertices() were called. This property defines * cogl_primitive_set_n_vertices() were called. This property defines
* the number of vertices to read when drawing. * the number of vertices to read when drawing.
@ -593,7 +593,7 @@ cogl_primitive_new_p3t2 (CoglContext *context,
* *
* The value passed as @n_vertices is initially used to determine how * The value passed as @n_vertices is initially used to determine how
* much can be read from @data but it will also be used to update the * much can be read from @data but it will also be used to update the
* #CoglPrimitive::n_vertices property as if * #CoglPrimitive <structfield>n_vertices</structfield> property as if
* cogl_primitive_set_n_vertices() were called. This property defines * cogl_primitive_set_n_vertices() were called. This property defines
* the number of vertices to read when drawing. * the number of vertices to read when drawing.
@ -648,7 +648,7 @@ cogl_primitive_new_p2t2c4 (CoglContext *context,
* *
* The value passed as @n_vertices is initially used to determine how * The value passed as @n_vertices is initially used to determine how
* much can be read from @data but it will also be used to update the * much can be read from @data but it will also be used to update the
* #CoglPrimitive::n_vertices property as if * #CoglPrimitive <structfield>n_vertices</structfield> property as if
* cogl_primitive_set_n_vertices() were called. This property defines * cogl_primitive_set_n_vertices() were called. This property defines
* the number of vertices to read when drawing. * the number of vertices to read when drawing.
@ -765,14 +765,14 @@ cogl_primitive_set_attributes (CoglPrimitive *primitive,
* shared data multiple times instead of duplicating the data. * shared data multiple times instead of duplicating the data.
* *
* The value passed as @n_indices will simply update the * The value passed as @n_indices will simply update the
* #CoglPrimitive::n_vertices property as if * #CoglPrimitive <structfield>n_vertices</structfield> property as if
* cogl_primitive_set_n_vertices() were called. This property defines * cogl_primitive_set_n_vertices() were called. This property defines
* the number of vertices to draw or, put another way, how many * the number of vertices to draw or, put another way, how many
* indices should be read from @indices when drawing. * indices should be read from @indices when drawing.
* *
* <note>The #CoglPrimitive::first_vertex property also affects * <note>The #CoglPrimitive <structfield>first_vertex</structfield> property
* drawing with indices by defining the first entry of the indices to * also affects drawing with indices by defining the first entry of the
* start drawing from.</note> * indices to start drawing from.</note>
* *
* Since: 1.10 * Since: 1.10
* Stability: unstable * Stability: unstable