From 91220c4b46fe75b21b4ebd99a63fd796f6fc56b0 Mon Sep 17 00:00:00 2001
From: Emmanuele Bassi <ebassi@linux.intel.com>
Date: Tue, 1 Jun 2010 14:14:41 +0100
Subject: [PATCH] docs: Miscellaneous fixes to silence gtk-doc

---
 clutter/clutter-texture.c                  |  3 ++-
 clutter/cogl/cogl/cogl.h                   | 29 +++++++++++-----------
 doc/reference/clutter/clutter-sections.txt |  6 +++++
 3 files changed, 22 insertions(+), 16 deletions(-)

diff --git a/clutter/clutter-texture.c b/clutter/clutter-texture.c
index c80061825..6f2c9250b 100644
--- a/clutter/clutter-texture.c
+++ b/clutter/clutter-texture.c
@@ -2826,6 +2826,8 @@ clutter_texture_get_load_data_async (ClutterTexture *texture)
 /**
  * clutter_texture_set_pick_with_alpha:
  * @texture: a #ClutterTexture
+ * @pick_with_alpha: %TRUE if the alpha channel should affect the
+ *   picking shape
  *
  * Sets whether @texture should have it's shape defined by the alpha
  * channel when picking.
@@ -2861,7 +2863,6 @@ clutter_texture_set_pick_with_alpha (ClutterTexture *texture,
     }
 
   /* NB: the pick material is created lazily when we first pick */
-
   priv->pick_with_alpha = pick_with_alpha;
 }
 
diff --git a/clutter/cogl/cogl/cogl.h b/clutter/cogl/cogl/cogl.h
index 4b61d35da..2121851e0 100644
--- a/clutter/cogl/cogl/cogl.h
+++ b/clutter/cogl/cogl/cogl.h
@@ -914,10 +914,10 @@ cogl_set_framebuffer (CoglHandle buffer);
  *
  * You should understand that a framebuffer owns the following state:
  * <itemizedlist>
- *  <li>The projection matrix</li>
- *  <li>The modelview matrix stack</li>
- *  <li>The viewport</li>
- *  <li>The clip stack</li>
+ *  <listitem><simpara>The projection matrix</simpara></listitem>
+ *  <listitem><simpara>The modelview matrix stack</simpara></listitem>
+ *  <listitem><simpara>The viewport</simpara></listitem>
+ *  <listitem><simpara>The clip stack</simpara></listitem>
  * </itemizedlist>
  * So these items will automatically be saved and restored when you
  * push and pop between different framebuffers.
@@ -948,34 +948,33 @@ cogl_set_framebuffer (CoglHandle buffer);
  *   cogl_set_viewport (0, 0, width, height);
  *   cogl_perspective (fovy, aspect, z_near, z_far);
  *
- *   cogl_get_projection_matrix (&projection_matrix);
+ *   cogl_get_projection_matrix (&amp;projection_matrix);
  *   z_camera = 0.5 * projection_matrix.xx;
  *
- *   cogl_matrix_init_identity (&mv_matrix);
- *   cogl_matrix_translate (&mv_matrix, -0.5f, -0.5f, -z_camera);
- *   cogl_matrix_scale (&mv_matrix, 1.0f / width, -1.0f / height, 1.0f / width);
- *   cogl_matrix_translate (&mv_matrix, 0.0f, -1.0 * height, 0.0f);
- *   cogl_set_modelview_matrix (&mv_matrix);
+ *   cogl_matrix_init_identity (&amp;mv_matrix);
+ *   cogl_matrix_translate (&amp;mv_matrix, -0.5f, -0.5f, -z_camera);
+ *   cogl_matrix_scale (&amp;mv_matrix, 1.0f / width, -1.0f / height, 1.0f / width);
+ *   cogl_matrix_translate (&amp;mv_matrix, 0.0f, -1.0 * height, 0.0f);
+ *   cogl_set_modelview_matrix (&amp;mv_matrix);
  * }
  *
  * static void
- * my_init_framebuffer (CoglHandle framebuffer,
+ * my_init_framebuffer (ClutterStage *stage,
+ *                      CoglHandle framebuffer,
  *                      unsigned int framebuffer_width,
  *                      unsigned int framebuffer_height)
  * {
- *   ClutterActor *stage = clutter_stage_get_default ();
  *   ClutterPerspective perspective;
  *
- *   clutter_stage_get_perspective (CLUTTER_STAGE (stage), &perspective);
+ *   clutter_stage_get_perspective (stage, &perspective);
  *
  *   cogl_push_framebuffer (framebuffer);
  *   setup_viewport (framebuffer_width,
  *                   framebuffer_height,
- *                   perspective->fovy,
+ *                   perspective.fovy,
  *                   perspective.aspect,
  *                   perspective.z_near,
  *                   perspective.z_far);
- *   cogl_pop_framebuffer ();
  * }
  * ]|
  *
diff --git a/doc/reference/clutter/clutter-sections.txt b/doc/reference/clutter/clutter-sections.txt
index ec6297302..db110c9e6 100644
--- a/doc/reference/clutter/clutter-sections.txt
+++ b/doc/reference/clutter/clutter-sections.txt
@@ -494,9 +494,13 @@ clutter_texture_set_from_file
 clutter_texture_set_from_rgb_data
 clutter_texture_set_from_yuv_data
 clutter_texture_set_area_from_rgb_data
+
+<SUBSECTION>
 clutter_texture_get_base_size
 clutter_texture_get_pixel_format
 clutter_texture_get_max_tile_waste
+
+<SUBSECTION>
 clutter_texture_get_filter_quality
 clutter_texture_set_filter_quality
 clutter_texture_get_cogl_texture
@@ -513,6 +517,8 @@ clutter_texture_get_load_async
 clutter_texture_set_load_async
 clutter_texture_get_load_data_async
 clutter_texture_set_load_data_async
+clutter_texture_get_pick_with_alpha
+clutter_texture_set_pick_with_alpha
 
 <SUBSECTION Standard>
 CLUTTER_TEXTURE