From ce174654bf7d743ec2eb18b92c72ab64c9ed7a10 Mon Sep 17 00:00:00 2001
From: Emmanuele Bassi <ebassi@linux.intel.com>
Date: Mon, 20 Sep 2010 13:15:44 +0100
Subject: [PATCH] docs: API reference fixes

---
 clutter/clutter-timeout-pool.h                |  4 +++
 clutter/cogl/cogl/cogl-path.h                 |  2 ++
 .../cogl/winsys/cogl-texture-pixmap-x11.h     | 18 ++++++----
 doc/reference/cally/cally-sections.txt        | 36 +++++++++----------
 doc/reference/clutter/clutter-sections.txt    |  4 +--
 5 files changed, 36 insertions(+), 28 deletions(-)

diff --git a/clutter/clutter-timeout-pool.h b/clutter/clutter-timeout-pool.h
index 2c029a379..b31039e35 100644
--- a/clutter/clutter-timeout-pool.h
+++ b/clutter/clutter-timeout-pool.h
@@ -42,6 +42,10 @@ G_BEGIN_DECLS
 /**
  * ClutterTimeoutPool: (skip)
  *
+ * <structname>ClutterTimeoutPool</structname> is an opaque structure
+ * whose members cannot be directly accessed.
+ *
+ * Since: 0.6
  */
 typedef struct _ClutterTimeoutPool    ClutterTimeoutPool;
 
diff --git a/clutter/cogl/cogl/cogl-path.h b/clutter/cogl/cogl/cogl-path.h
index edeefe0dc..cd553c7ce 100644
--- a/clutter/cogl/cogl/cogl-path.h
+++ b/clutter/cogl/cogl/cogl-path.h
@@ -125,6 +125,8 @@ cogl_path_set_fill_rule (CoglPathFillRule fill_rule);
 /**
  * cogl_path_get_fill_rule:
  *
+ * Retrieves the fill rule set using cogl_path_set_fill_rule().
+ *
  * Return value: the fill rule that is used for the current path.
  *
  * Since: 1.4
diff --git a/clutter/cogl/cogl/winsys/cogl-texture-pixmap-x11.h b/clutter/cogl/cogl/winsys/cogl-texture-pixmap-x11.h
index 198866265..b2a4ae057 100644
--- a/clutter/cogl/cogl/winsys/cogl-texture-pixmap-x11.h
+++ b/clutter/cogl/cogl/winsys/cogl-texture-pixmap-x11.h
@@ -96,11 +96,13 @@ cogl_texture_pixmap_x11_update_area (CoglHandle handle,
  * cogl_texture_pixmap_x11_is_using_tfp_extension:
  * @handle: A CoglHandle to a CoglTexturePixmapX11 instance
  *
- * Return value: whether the texture is using the
- * GLX_EXT_texture_from_pixmap or similar extension to copy the
- * contents of the pixmap to the texture. This extension is usually
- * implemented as zero-copy so it implies the updates are working
- * efficiently.
+ * Checks whether the texture is using the GLX_EXT_texture_from_pixmap
+ * or similar extension to copy the contents of the pixmap to the texture.
+ * This extension is usually implemented as zero-copy operation so it
+ * implies the updates are working efficiently.
+ *
+ * Return value: %TRUE if the texture is using an efficient extension
+ *   and %FALSE otherwise
  *
  * Since: 1.4
  * Stability: Unstable
@@ -137,8 +139,10 @@ cogl_texture_pixmap_x11_set_damage_object (CoglHandle handle,
  * cogl_is_texture_pixmap_x11:
  * @handle: A CoglHandle
  *
- * Return value: whether @handle points to a CoglTexturePixmapX11
- * instance.
+ * Checks whether @handle points to a CoglTexturePixmapX11 instance.
+ *
+ * Return value: %TRUE if the handle is a CoglTexturePixmapX11, and
+ *   %FALSE otherwise
  *
  * Since: 1.4
  * Stability: Unstable
diff --git a/doc/reference/cally/cally-sections.txt b/doc/reference/cally/cally-sections.txt
index bf275e9f0..40389d784 100644
--- a/doc/reference/cally/cally-sections.txt
+++ b/doc/reference/cally/cally-sections.txt
@@ -1,3 +1,21 @@
+<SECTION>
+<FILE>cally-stage</FILE>
+<TITLE>CallyStage</TITLE>
+CallyStage
+CallyStageClass
+cally_stage_new
+<SUBSECTION Standard>
+CALLY_STAGE
+CALLY_IS_STAGE
+CALLY_TYPE_STAGE
+CALLY_STAGE_CLASS
+CALLY_IS_STAGE_CLASS
+CALLY_STAGE_GET_CLASS
+<SUBSECTION Private>
+CallyStagePrivate
+cally_stage_get_type
+</SECTION>
+
 <SECTION>
 <FILE>cally-clone</FILE>
 <TITLE>CallyClone</TITLE>
@@ -127,24 +145,6 @@ CallyGroupPrivate
 cally_group_get_type
 </SECTION>
 
-<SECTION>
-<FILE>cally-stage</FILE>
-<TITLE>CallyStage</TITLE>
-CallyStage
-CallyStageClass
-cally_stage_new
-<SUBSECTION Standard>
-CALLY_STAGE
-CALLY_IS_STAGE
-CALLY_TYPE_STAGE
-CALLY_STAGE_CLASS
-CALLY_IS_STAGE_CLASS
-CALLY_STAGE_GET_CLASS
-<SUBSECTION Private>
-CallyStagePrivate
-cally_stage_get_type
-</SECTION>
-
 <SECTION>
 <FILE>cally-rectangle</FILE>
 <TITLE>CallyRectangle</TITLE>
diff --git a/doc/reference/clutter/clutter-sections.txt b/doc/reference/clutter/clutter-sections.txt
index c22800085..ade6f47c5 100644
--- a/doc/reference/clutter/clutter-sections.txt
+++ b/doc/reference/clutter/clutter-sections.txt
@@ -911,10 +911,8 @@ CLUTTER_VALUE_HOLDS_FIXED
 clutter_value_set_fixed
 clutter_value_get_fixed
 
-<SUBSECTION Standard>
-ClutterTimeoutPool
-
 <SUBSECTION Private>
+ClutterTimeoutPool
 CLUTTER_TYPE_PARAM_FIXED
 CLUTTER_PARAM_SPEC_FIXED
 CLUTTER_IS_PARAM_SPEC_FIXED