sungmg/mutter-performance-source
1
0
Fork 0
Code Activity

doc: Include the documentation for CoglEuler

Browse source 
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)
This commit is contained in:
Damien Lespiau 2012-05-11 11:57:03 +01:00 committed by Robert Bragg
parent e172cac480
commit 86a5259578
3 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
cogl/cogl-euler.h
View file

@ -62,7 +62,7 @@ G_BEGIN_DECLS
* <listitem> * <listitem>
* Easy to understand and use, compared to quaternions and matrices, * Easy to understand and use, compared to quaternions and matrices,
* so may be a good choice for a user interface. * so may be a good choice for a user interface.
* <listitem> * </listitem>
* <listitem> * <listitem>
* Efficient storage, needing only 3 components any rotation can be * Efficient storage, needing only 3 components any rotation can be
* represented. * represented.
@ -105,7 +105,7 @@ G_BEGIN_DECLS
* slightly different aeronautical terms, such as "yaw" instead of * slightly different aeronautical terms, such as "yaw" instead of
* "heading" or "bank" instead of "roll". * "heading" or "bank" instead of "roll".
* </listitem> * </listitem>
* </itemlist> * </itemizedlist>
* *
* To minimize the aliasing issue we may refer to "Canonical Euler" * To minimize the aliasing issue we may refer to "Canonical Euler"
* angles where heading and roll are restricted to +- 180° and pitch is * angles where heading and roll are restricted to +- 180° and pitch is

1
doc/reference/cogl-2.0-experimental/cogl-2.0-experimental-docs.xml.in
View file

@ -125,6 +125,7 @@
<xi:include href="xml/cogl-color.xml"/> <xi:include href="xml/cogl-color.xml"/>
<xi:include href="xml/cogl-matrix.xml"/> <xi:include href="xml/cogl-matrix.xml"/>
<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-quaternion.xml"/> <xi:include href="xml/cogl-quaternion.xml"/>
<xi:include href="xml/cogl-types.xml"/> <xi:include href="xml/cogl-types.xml"/>
<xi:include href="xml/cogl-version.xml"/> <xi:include href="xml/cogl-version.xml"/>

1
doc/reference/cogl-2.0-experimental/cogl-2.0-experimental-sections.txt
View file

@ -566,6 +566,7 @@ cogl_matrix_project_points
cogl_matrix_is_identity cogl_matrix_is_identity
</SECTION> </SECTION>
<SECTION>
<FILE>cogl-euler</FILE> <FILE>cogl-euler</FILE>
<TITLE>Eulers (Rotations)</TITLE> <TITLE>Eulers (Rotations)</TITLE>
CoglEuler CoglEuler