[cogl/wip/rib/cogl-1.12: 38/139] doc: Include the documentation for CoglEuler
- From: Robert Bragg <rbragg src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [cogl/wip/rib/cogl-1.12: 38/139] doc: Include the documentation for CoglEuler
- Date: Wed, 15 Aug 2012 13:06:38 +0000 (UTC)
commit 86a5259578f81c1d1e047a786aa8f6718d99c302
Author: Damien Lespiau <damien lespiau intel com>
Date: Fri May 11 11:57:03 2012 +0100
doc: Include the documentation for CoglEuler
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
Reviewed-by: Robert Bragg <robert linux intel com>
(cherry picked from commit c7f6e07f7b8ba0d7dc9604e888c8a46165ec3ed4)
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 0d1ec02..e301202 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 8e3a302..411503f 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
@@ -125,6 +125,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"/>
<xi:include href="xml/cogl-version.xml"/>
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 acc0eae..d0476ea 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
@@ -566,6 +566,7 @@ cogl_matrix_project_points
cogl_matrix_is_identity
</SECTION>
+<SECTION>
<FILE>cogl-euler</FILE>
<TITLE>Eulers (Rotations)</TITLE>
CoglEuler
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]