[cogl/wip/cogl-1.14: 144/177] doc: Don't use '::' to denote an object property



commit 34d06b1be92ebf499509f0d198cc7923392b85f5
Author: Damien Lespiau <damien lespiau intel com>
Date:   Mon Dec 31 16:12:03 2012 +0000

    doc: Don't use '::' to denote an object property
    
    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)

 cogl/cogl-primitive.h |   26 +++++++++++++-------------
 1 files changed, 13 insertions(+), 13 deletions(-)
---
diff --git a/cogl/cogl-primitive.h b/cogl/cogl-primitive.h
index b004397..e4a564b 100644
--- a/cogl/cogl-primitive.h
+++ b/cogl/cogl-primitive.h
@@ -217,7 +217,7 @@ typedef struct {
  * drawn later with no addition information required.
  *
  * 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
  * 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
  * 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
  * 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
  * 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
  * 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
  * 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
  * 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
  * 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
  * 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
  * 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
  * 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
  * 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
  * 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
  * 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
  * 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
  * 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
  * 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.
  *
  * 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
  * the number of vertices to draw or, put another way, how many
  * indices should be read from @indices when drawing.
  *
- * <note>The #CoglPrimitive::first_vertex property also affects
- * drawing with indices by defining the first entry of the indices to
- * start drawing from.</note>
+ * <note>The #CoglPrimitive <structfield>first_vertex</structfield> property
+ * also affects drawing with indices by defining the first entry of the
+ * indices to start drawing from.</note>
  *
  * Since: 1.10
  * Stability: unstable



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]