[Cogl] [PATCH 39/53] doc: Populate cogl-types a bit more and move it to the general section

[Damien Lespiau]

From: Damien Lespiau <damien.lespiau at intel.com>

I just added the general types creating warnings in the current state of the
documentation (ie the ones references by already documented functions)
and moved the section from the 'Utility' section to the 'General'
section which I believe is a better fit as they are used by more than
one type and not really utilities.
---
 cogl/cogl-primitive.h                  |   24 +++++++-------------
 cogl/cogl-types.h                      |    7 ++++++
 doc/reference/cogl2/cogl2-docs.xml.in  |    2 +-
 doc/reference/cogl2/cogl2-sections.txt |   37 ++++++++++++++++++++++---------
 4 files changed, 42 insertions(+), 28 deletions(-)

diff --git a/cogl/cogl-primitive.h b/cogl/cogl-primitive.h
index 4302642..0e1ccd1 100644
--- a/cogl/cogl-primitive.h
+++ b/cogl/cogl-primitive.h
@@ -60,8 +60,7 @@ COGL_BEGIN_DECLS
  * Since: 1.6
  * Stability: Unstable
  */
-typedef struct
-{
+typedef struct {
    float x, y;
 } CoglVertexP2;
 
@@ -77,8 +76,7 @@ typedef struct
  * Since: 1.6
  * Stability: Unstable
  */
-typedef struct
-{
+typedef struct {
    float x, y, z;
 } CoglVertexP3;
 
@@ -97,8 +95,7 @@ typedef struct
  * Since: 1.6
  * Stability: Unstable
  */
-typedef struct
-{
+typedef struct {
    float x, y;
    uint8_t r, g, b, a;
 } CoglVertexP2C4;
@@ -119,8 +116,7 @@ typedef struct
  * Since: 1.6
  * Stability: Unstable
  */
-typedef struct
-{
+typedef struct {
    float x, y, z;
    uint8_t r, g, b, a;
 } CoglVertexP3C4;
@@ -138,8 +134,7 @@ typedef struct
  * Since: 1.6
  * Stability: Unstable
  */
-typedef struct
-{
+typedef struct {
    float x, y;
    float s, t;
 } CoglVertexP2T2;
@@ -158,8 +153,7 @@ typedef struct
  * Since: 1.6
  * Stability: Unstable
  */
-typedef struct
-{
+typedef struct {
    float x, y, z;
    float s, t;
 } CoglVertexP3T2;
@@ -182,8 +176,7 @@ typedef struct
  * Since: 1.6
  * Stability: Unstable
  */
-typedef struct
-{
+typedef struct {
    float x, y;
    float s, t;
    uint8_t r, g, b, a;
@@ -207,8 +200,7 @@ typedef struct
  * Since: 1.6
  * Stability: Unstable
  */
-typedef struct
-{
+typedef struct {
    float x, y, z;
    float s, t;
    uint8_t r, g, b, a;
diff --git a/cogl/cogl-types.h b/cogl/cogl-types.h
index 4450e72..55ab083 100644
--- a/cogl/cogl-types.h
+++ b/cogl/cogl-types.h
@@ -45,6 +45,13 @@
 COGL_BEGIN_DECLS
 
 /**
+ * SECTION:cogl-types
+ * @short_description: Types used throughout the library
+ *
+ * General types used by various Cogl functions.
+*/
+
+/**
  * CoglBool:
  *
  * A boolean data type used throughout the Cogl C api. This should be
diff --git a/doc/reference/cogl2/cogl2-docs.xml.in b/doc/reference/cogl2/cogl2-docs.xml.in
index 06bc0ec..25380f6 100644
--- a/doc/reference/cogl2/cogl2-docs.xml.in
+++ b/doc/reference/cogl2/cogl2-docs.xml.in
@@ -65,6 +65,7 @@
       <title>General API concepts</title>
       <xi:include href="xml/cogl-object.xml"/>
       <xi:include href="xml/cogl-error.xml"/>
+      <xi:include href="xml/cogl-types.xml"/>
     </section>
 
     <section id="cogl-context-apis">
@@ -139,7 +140,6 @@
       <xi:include href="xml/cogl-vector.xml"/>
       <xi:include href="xml/cogl-euler.xml"/>
       <xi:include href="xml/cogl-quaternion.xml"/>
-      <xi:include href="xml/cogl-types.xml"/>
       <xi:include href="xml/cogl-version.xml"/>
     </section>
 
diff --git a/doc/reference/cogl2/cogl2-sections.txt b/doc/reference/cogl2/cogl2-sections.txt
index 3dee535..2316f4f 100644
--- a/doc/reference/cogl2/cogl2-sections.txt
+++ b/doc/reference/cogl2/cogl2-sections.txt
@@ -21,6 +21,32 @@ COGL_GLIB_ERROR
 </SECTION>
 
 <SECTION>
+<FILE>cogl-types</FILE>
+<TITLE>Common Types</TITLE>
+<SUBSECTION>
+CoglVertexP2
+CoglVertexP3
+CoglVertexP2C4
+CoglVertexP3C4
+CoglVertexP2T2
+CoglVertexP3T2
+CoglVertexP2T2C4
+CoglVertexP3T2C4
+CoglVerticesMode
+
+<SUBSECTION>
+CoglFuncPtr
+CoglPixelFormat
+CoglBufferTarget
+CoglBufferBit
+CoglAttributeType
+CoglColorMask
+
+<SUBSECTION>
+CoglBool
+</SECTION>
+
+<SECTION>
 <FILE>cogl-renderer</FILE>
 <TITLE>CoglRenderer: Connect to a backend renderer</TITLE>
 cogl_renderer_new
@@ -802,17 +828,6 @@ COGL_VERSION_GET_MICRO
 </SECTION>
 
 <SECTION>
-<FILE>cogl-types</FILE>
-<TITLE>Common Types</TITLE>
-CoglFuncPtr
-CoglPixelFormat
-CoglBufferTarget
-CoglBufferBit
-CoglAttributeType
-CoglColorMask
-</SECTION>
-
-<SECTION>
 <FILE>cogl-gtype</FILE>
 <TITLE>GType Integration API</TITLE>
 cogl_gtype_matrix_get_type
-- 
1.7.7.5