From 614cd7e895f3ebda736b305625ed9e4d48003f6c Mon Sep 17 00:00:00 2001
From: Tomas Frydrych <tf@openedhand.com>
Date: Thu, 18 Jan 2007 10:33:24 +0000
Subject: [PATCH] documentation fixed for clutter-fixed

---
 ChangeLog                             |  4 +++
 clutter/clutter-fixed.h               |  2 +-
 doc/reference/ChangeLog               |  5 ++++
 doc/reference/clutter-docs.sgml       |  1 +
 doc/reference/tmpl/clutter-fixed.sgml | 40 +++++++++++++++++++++++----
 5 files changed, 45 insertions(+), 7 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 47e2528b9..b66b8153d 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2007-01-18  Tomas Frydrych  <tf@openedhand.com>
+
+	* clutter/clutter-fixed.h: fixed a typo in comment
+	
 2007-01-18  Emmanuele Bassi  <ebassi@openedhand.com>
 
 	* clutter/clutter-fixed.h: Remove some inline documentation to
diff --git a/clutter/clutter-fixed.h b/clutter/clutter-fixed.h
index f7b7cfad5..206ac62d3 100644
--- a/clutter/clutter-fixed.h
+++ b/clutter/clutter-fixed.h
@@ -40,7 +40,7 @@ typedef gint32 ClutterFixed;
 /**
  * ClutterAngle:
  * 
- * Integer representation of an agnle such that 1024 corresponds to
+ * Integer representation of an angle such that 1024 corresponds to
  * full circle (i.e., 2*Pi).
  */
 typedef gint32 ClutterAngle;    /* angle such that 1024 == 2*PI */
diff --git a/doc/reference/ChangeLog b/doc/reference/ChangeLog
index 45cebd305..9502fb103 100644
--- a/doc/reference/ChangeLog
+++ b/doc/reference/ChangeLog
@@ -1,3 +1,8 @@
+2007-01-18  Tomas Frydrych  <tf@openedhand.com>
+
+	* clutter-docs.sgml: added clutter-fixed
+	* tmpl/clutter-fixed.sgml: added intro to fixed point math
+	
 2007-01-18  Emmanuele Bassi  <ebassi@openedhand.com>
 
 	* clutter-sections.txt: Remove old cruft.
diff --git a/doc/reference/clutter-docs.sgml b/doc/reference/clutter-docs.sgml
index b7c057eec..ab4c5e793 100644
--- a/doc/reference/clutter-docs.sgml
+++ b/doc/reference/clutter-docs.sgml
@@ -91,6 +91,7 @@
     <xi:include href="xml/clutter-event.xml"/>
     <xi:include href="xml/clutter-color.xml"/>
     <xi:include href="xml/clutter-util.xml"/>
+    <xi:include href="xml/clutter-fixed.xml"/>
     <xi:include href="xml/clutter-version.xml"/>
   </chapter>
 
diff --git a/doc/reference/tmpl/clutter-fixed.sgml b/doc/reference/tmpl/clutter-fixed.sgml
index fd6c29ff9..2c8b18b7e 100644
--- a/doc/reference/tmpl/clutter-fixed.sgml
+++ b/doc/reference/tmpl/clutter-fixed.sgml
@@ -13,6 +13,34 @@ emulation, relying on integer math for fixed-to-floating and
 floating-to-fixed conversion.
 </para>
 
+<section>
+<title>Basic Rules of Fixed Point Arithmetic</title>
+<itemizedlist>
+<listitem>
+<para>
+Two fixed point numbers can be directly added and subtracted.
+</para>
+</listitem>
+<listitem>
+<para>
+To add other numerical type to a fixed point number it has to be first 
+converted to fixed point.
+</para>
+</listitem>
+<listitem>
+<para>
+A fixed point number can be directly multiplied or divided by an integer.
+</para>
+</listitem>
+<listitem>
+<para>
+Two fixed point numbers can only be multiplied and divided by the provided
+#CLUTTER_FIXED_MUL (aka #CFX_MUL) and #CLUTTER_FIXED_DIV (aka #CFX_DIV) macros.
+</para>
+</listitem>
+</itemizedlist>
+</section>
+
 <!-- ##### SECTION See_Also ##### -->
 <para>
 
@@ -27,6 +55,12 @@ floating-to-fixed conversion.
 </para>
 
 
+<!-- ##### TYPEDEF ClutterAngle ##### -->
+<para>
+
+</para>
+
+
 <!-- ##### MACRO CFX_Q ##### -->
 <para>
 Number of bits used to store fractional part of #ClutterFixed.
@@ -55,12 +89,6 @@ Minumum number representable by #ClutterFixed.
 
 
 
-<!-- ##### TYPEDEF ClutterAngle ##### -->
-<para>
-
-</para>
-
-
 <!-- ##### MACRO CFX_PI ##### -->
 <para>