[Cogl] [PATCH 4/6] doc: Include the documentation for CoglEuler
Damien Lespiau
damien.lespiau at gmail.com
Sat May 12 12:45:34 PDT 2012
From: Damien Lespiau <damien.lespiau at intel.com>
Several little changes were needed to make the CoglEuler documentation
appear:
• Fix the embeded docbook snippet in the CoglEuler section header
• Add the xinclude directive to the main document
• Add the missing <SECTION> in -sections.txt
---
cogl/cogl-euler.h | 4 ++--
.../cogl-2.0-experimental-docs.xml.in | 1 +
.../cogl-2.0-experimental-sections.txt | 1 +
3 files changed, 4 insertions(+), 2 deletions(-)
diff --git a/cogl/cogl-euler.h b/cogl/cogl-euler.h
index e82eab1..c36792f 100644
--- a/cogl/cogl-euler.h
+++ b/cogl/cogl-euler.h
@@ -62,7 +62,7 @@ G_BEGIN_DECLS
* <listitem>
* Easy to understand and use, compared to quaternions and matrices,
* so may be a good choice for a user interface.
- * <listitem>
+ * </listitem>
* <listitem>
* Efficient storage, needing only 3 components any rotation can be
* represented.
@@ -105,7 +105,7 @@ G_BEGIN_DECLS
* slightly different aeronautical terms, such as "yaw" instead of
* "heading" or "bank" instead of "roll".
* </listitem>
- * </itemlist>
+ * </itemizedlist>
*
* To minimize the aliasing issue we may refer to "Canonical Euler"
* angles where heading and roll are restricted to +- 180° and pitch is
diff --git a/doc/reference/cogl-2.0-experimental/cogl-2.0-experimental-docs.xml.in b/doc/reference/cogl-2.0-experimental/cogl-2.0-experimental-docs.xml.in
index 3f49e62..2e4ba6e 100644
--- a/doc/reference/cogl-2.0-experimental/cogl-2.0-experimental-docs.xml.in
+++ b/doc/reference/cogl-2.0-experimental/cogl-2.0-experimental-docs.xml.in
@@ -119,6 +119,7 @@
<xi:include href="xml/cogl-color.xml"/>
<xi:include href="xml/cogl-matrix.xml"/>
<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"/>
</section>
diff --git a/doc/reference/cogl-2.0-experimental/cogl-2.0-experimental-sections.txt b/doc/reference/cogl-2.0-experimental/cogl-2.0-experimental-sections.txt
index e318222..6db7fac 100644
--- a/doc/reference/cogl-2.0-experimental/cogl-2.0-experimental-sections.txt
+++ b/doc/reference/cogl-2.0-experimental/cogl-2.0-experimental-sections.txt
@@ -555,6 +555,7 @@ cogl_matrix_project_points
cogl_matrix_is_identity
</SECTION>
+<SECTION>
<FILE>cogl-euler</FILE>
<TITLE>Eulers (Rotations)</TITLE>
CoglEuler
--
1.7.7.5
More information about the Cogl
mailing list