doc: Populate cogl-types a bit more and move it to the general section

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.

(cherry picked from commit c51b147789763863ef32482d7ffa936160ed7c93)
This commit is contained in:
Damien Lespiau 2012-12-31 16:08:12 +00:00 committed by Robert Bragg
parent 5c12c36c58
commit 780b01f1c8
4 changed files with 42 additions and 28 deletions

View File

@ -60,8 +60,7 @@ COGL_BEGIN_DECLS
* Since: 1.6 * Since: 1.6
* Stability: Unstable * Stability: Unstable
*/ */
typedef struct typedef struct {
{
float x, y; float x, y;
} CoglVertexP2; } CoglVertexP2;
@ -77,8 +76,7 @@ typedef struct
* Since: 1.6 * Since: 1.6
* Stability: Unstable * Stability: Unstable
*/ */
typedef struct typedef struct {
{
float x, y, z; float x, y, z;
} CoglVertexP3; } CoglVertexP3;
@ -97,8 +95,7 @@ typedef struct
* Since: 1.6 * Since: 1.6
* Stability: Unstable * Stability: Unstable
*/ */
typedef struct typedef struct {
{
float x, y; float x, y;
uint8_t r, g, b, a; uint8_t r, g, b, a;
} CoglVertexP2C4; } CoglVertexP2C4;
@ -119,8 +116,7 @@ typedef struct
* Since: 1.6 * Since: 1.6
* Stability: Unstable * Stability: Unstable
*/ */
typedef struct typedef struct {
{
float x, y, z; float x, y, z;
uint8_t r, g, b, a; uint8_t r, g, b, a;
} CoglVertexP3C4; } CoglVertexP3C4;
@ -138,8 +134,7 @@ typedef struct
* Since: 1.6 * Since: 1.6
* Stability: Unstable * Stability: Unstable
*/ */
typedef struct typedef struct {
{
float x, y; float x, y;
float s, t; float s, t;
} CoglVertexP2T2; } CoglVertexP2T2;
@ -158,8 +153,7 @@ typedef struct
* Since: 1.6 * Since: 1.6
* Stability: Unstable * Stability: Unstable
*/ */
typedef struct typedef struct {
{
float x, y, z; float x, y, z;
float s, t; float s, t;
} CoglVertexP3T2; } CoglVertexP3T2;
@ -182,8 +176,7 @@ typedef struct
* Since: 1.6 * Since: 1.6
* Stability: Unstable * Stability: Unstable
*/ */
typedef struct typedef struct {
{
float x, y; float x, y;
float s, t; float s, t;
uint8_t r, g, b, a; uint8_t r, g, b, a;
@ -207,8 +200,7 @@ typedef struct
* Since: 1.6 * Since: 1.6
* Stability: Unstable * Stability: Unstable
*/ */
typedef struct typedef struct {
{
float x, y, z; float x, y, z;
float s, t; float s, t;
uint8_t r, g, b, a; uint8_t r, g, b, a;

View File

@ -48,6 +48,13 @@
COGL_BEGIN_DECLS COGL_BEGIN_DECLS
/**
* SECTION:cogl-types
* @short_description: Types used throughout the library
*
* General types used by various Cogl functions.
*/
/** /**
* CoglBool: * CoglBool:
* *

View File

@ -65,6 +65,7 @@
<title>General API concepts</title> <title>General API concepts</title>
<xi:include href="xml/cogl-object.xml"/> <xi:include href="xml/cogl-object.xml"/>
<xi:include href="xml/cogl-error.xml"/> <xi:include href="xml/cogl-error.xml"/>
<xi:include href="xml/cogl-types.xml"/>
</section> </section>
<section id="cogl-context-apis"> <section id="cogl-context-apis">
@ -140,7 +141,6 @@
<xi:include href="xml/cogl-vector.xml"/> <xi:include href="xml/cogl-vector.xml"/>
<xi:include href="xml/cogl-euler.xml"/> <xi:include href="xml/cogl-euler.xml"/>
<xi:include href="xml/cogl-quaternion.xml"/> <xi:include href="xml/cogl-quaternion.xml"/>
<xi:include href="xml/cogl-types.xml"/>
<xi:include href="xml/cogl-version.xml"/> <xi:include href="xml/cogl-version.xml"/>
</section> </section>

View File

@ -20,6 +20,32 @@ cogl_error_copy
COGL_GLIB_ERROR COGL_GLIB_ERROR
</SECTION> </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> <SECTION>
<FILE>cogl-renderer</FILE> <FILE>cogl-renderer</FILE>
<TITLE>CoglRenderer: Connect to a backend renderer</TITLE> <TITLE>CoglRenderer: Connect to a backend renderer</TITLE>
@ -871,17 +897,6 @@ COGL_VERSION_GET_MINOR
COGL_VERSION_GET_MICRO COGL_VERSION_GET_MICRO
</SECTION> </SECTION>
<SECTION>
<FILE>cogl-types</FILE>
<TITLE>Common Types</TITLE>
CoglFuncPtr
CoglPixelFormat
CoglBufferTarget
CoglBufferBit
CoglAttributeType
CoglColorMask
</SECTION>
<SECTION> <SECTION>
<FILE>cogl-gtype</FILE> <FILE>cogl-gtype</FILE>
<TITLE>GType Integration API</TITLE> <TITLE>GType Integration API</TITLE>