From 2d5eeba5d89c129f991f367f0e80c3a152f19e52 Mon Sep 17 00:00:00 2001
From: Emmanuele Bassi <ebassi@linux.intel.com>
Date: Wed, 27 Jan 2010 21:14:43 +0000
Subject: [PATCH] docs: Fixes for TimeoutPool and Frame sources

The TimeoutPool is not used by ClutterTimeline any more, so we need to
remove a sentence from its description. We also need to fix the gtk-doc
syntax errors.
---
 clutter/clutter-frame-source.c | 25 +++++++++++++------------
 clutter/clutter-timeout-pool.c |  8 +-------
 2 files changed, 14 insertions(+), 19 deletions(-)

diff --git a/clutter/clutter-frame-source.c b/clutter/clutter-frame-source.c
index 4a2d65310..dc4e0f66f 100644
--- a/clutter/clutter-frame-source.c
+++ b/clutter/clutter-frame-source.c
@@ -39,24 +39,25 @@ struct _ClutterFrameSource
   ClutterTimeoutInterval timeout;
 };
 
-static gboolean clutter_frame_source_prepare  (GSource *source, gint *timeout);
-static gboolean clutter_frame_source_check    (GSource *source);
-static gboolean clutter_frame_source_dispatch (GSource    *source,
-					       GSourceFunc callback,
-					       gpointer    user_data);
+static gboolean clutter_frame_source_prepare  (GSource     *source,
+                                               gint        *timeout);
+static gboolean clutter_frame_source_check    (GSource     *source);
+static gboolean clutter_frame_source_dispatch (GSource     *source,
+                                               GSourceFunc  callback,
+                                               gpointer     user_data);
 
 static GSourceFuncs clutter_frame_source_funcs =
-  {
-    clutter_frame_source_prepare,
-    clutter_frame_source_check,
-    clutter_frame_source_dispatch,
-    NULL
-  };
+{
+  clutter_frame_source_prepare,
+  clutter_frame_source_check,
+  clutter_frame_source_dispatch,
+  NULL
+};
 
 /**
  * clutter_frame_source_add_full:
  * @priority: the priority of the frame source. Typically this will be in the
- *            range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.
+ *   range between %G_PRIORITY_DEFAULT and %G_PRIORITY_HIGH.
  * @fps: the number of times per second to call the function
  * @func: function to call
  * @data: data to pass to the function
diff --git a/clutter/clutter-timeout-pool.c b/clutter/clutter-timeout-pool.c
index d1cb48252..216e2897c 100644
--- a/clutter/clutter-timeout-pool.c
+++ b/clutter/clutter-timeout-pool.c
@@ -359,12 +359,6 @@ clutter_timeout_pool_finalize (GSource *source)
  * always sorted, so that the extraction of the next timeout function is
  * a constant time operation.
  *
- * Inside Clutter, every #ClutterTimeline share the same timeout pool, unless
- * the CLUTTER_TIMELINE=no-pool environment variable is set.
- *
- * #ClutterTimeoutPool is part of the #ClutterTimeline implementation
- * and should not be used by application developers.
- *
  * Return value: the newly created #ClutterTimeoutPool. The created pool
  *   is owned by the GLib default context and will be automatically
  *   destroyed when the context is destroyed. It is possible to force
@@ -412,7 +406,7 @@ clutter_timeout_pool_new (gint priority)
  * won't be called again. If @notify is not %NULL, the @notify function
  * will be called. The first call to @func will be at the end of @interval.
  *
- * Since version 0.8 this will try to compensate for delays. For
+ * Since Clutter 0.8 this will try to compensate for delays. For
  * example, if @func takes half the interval time to execute then the
  * function will be called again half the interval time after it
  * finished. Before version 0.8 it would not fire until a full