[clutter] docs: Update missing documentation



commit 4f0769d69d4216d197be325ab84059f2d6822ece
Author: Emmanuele Bassi <ebassi linux intel com>
Date:   Mon Jun 13 13:27:46 2011 +0100

    docs: Update missing documentation

 clutter/clutter-actor.c                    |   16 +++++++++++-----
 clutter/clutter-backend.c                  |   27 +++++++++++++++++++++++++++
 clutter/clutter-script.c                   |    1 +
 doc/reference/clutter/clutter-sections.txt |    2 ++
 4 files changed, 41 insertions(+), 5 deletions(-)
---
diff --git a/clutter/clutter-actor.c b/clutter/clutter-actor.c
index d06f006..9daf82c 100644
--- a/clutter/clutter-actor.c
+++ b/clutter/clutter-actor.c
@@ -12347,13 +12347,19 @@ clutter_actor_get_paint_box (ClutterActor    *self,
  * clutter_actor_has_overlaps:
  * @self: A #ClutterActor
  *
- * Return value: whether the actor may contain overlapping
- * primitives. Clutter uses this to determine whether the painting
- * should be redirected to an offscreen buffer to correctly implement
- * the opacity property. Custom actors can override this by
- * implementing the has_overlaps virtual. See
+ * Asks the actor's implementation whether it may contain overlapping
+ * primitives.
+ *
+ * Clutter uses this to determine whether the painting should be redirected
+ * to an offscreen buffer to correctly implement the opacity property.
+ *
+ * Custom actors can override the default response by implementing the
+ * #ClutterActor <function>has_overlaps</function> virtual function. See
  * clutter_actor_set_offscreen_redirect() for more information.
  *
+ * Return value: %TRUE if the actor may have overlapping primitives, and
+ *   %FALSE otherwise
+ *
  * Since: 1.8
  */
 gboolean
diff --git a/clutter/clutter-backend.c b/clutter/clutter-backend.c
index 0aa3215..f3f7144 100644
--- a/clutter/clutter-backend.c
+++ b/clutter/clutter-backend.c
@@ -260,6 +260,15 @@ clutter_backend_class_init (ClutterBackendClass *klass)
 
   g_type_class_add_private (gobject_class, sizeof (ClutterBackendPrivate));
 
+  /**
+   * ClutterBackend::resolution-changed:
+   * @backend: the #ClutterBackend that emitted the signal
+   *
+   * The ::resolution-changed signal is emitted each time the font
+   * resolutions has been changed through #ClutterSettings.
+   *
+   * Since: 1.0
+   */
   backend_signals[RESOLUTION_CHANGED] =
     g_signal_new (I_("resolution-changed"),
                   G_TYPE_FROM_CLASS (klass),
@@ -269,6 +278,15 @@ clutter_backend_class_init (ClutterBackendClass *klass)
                   _clutter_marshal_VOID__VOID,
                   G_TYPE_NONE, 0);
 
+  /**
+   * ClutterBackend::font-changed:
+   * @backend: the #ClutterBackend that emitted the signal
+   *
+   * The ::font-changed signal is emitted each time the font options
+   * have been changed through #ClutterSettings.
+   *
+   * Since: 1.0
+   */
   backend_signals[FONT_CHANGED] =
     g_signal_new (I_("font-changed"),
                   G_TYPE_FROM_CLASS (klass),
@@ -278,6 +296,15 @@ clutter_backend_class_init (ClutterBackendClass *klass)
                   _clutter_marshal_VOID__VOID,
                   G_TYPE_NONE, 0);
 
+  /**
+   * ClutterBackend::settings-changed:
+   * @backend: the #ClutterBackend that emitted the signal
+   *
+   * The ::settings-changed signal is emitted each time the #ClutterSettings
+   * properties have been changed.
+   *
+   * Since: 1.4
+   */
   backend_signals[SETTINGS_CHANGED] =
     g_signal_new (I_("settings-changed"),
                   G_TYPE_FROM_CLASS (klass),
diff --git a/clutter/clutter-script.c b/clutter/clutter-script.c
index c9b1a9f..b3625c0 100644
--- a/clutter/clutter-script.c
+++ b/clutter/clutter-script.c
@@ -1342,6 +1342,7 @@ clutter_script_list_objects (ClutterScript *script)
  * @script: a #ClutterScript
  * @name: (allow-none): a name for the @state, or %NULL to
  *   set the default #ClutterState
+ * @state: a #ClutterState
  *
  * Associates a #ClutterState to the #ClutterScript instance using the given
  * name.
diff --git a/doc/reference/clutter/clutter-sections.txt b/doc/reference/clutter/clutter-sections.txt
index 9cffede..7fc8faa 100644
--- a/doc/reference/clutter/clutter-sections.txt
+++ b/doc/reference/clutter/clutter-sections.txt
@@ -1383,6 +1383,8 @@ clutter_script_list_objects
 ClutterScriptConnectFunc
 clutter_script_connect_signals
 clutter_script_connect_signals_full
+clutter_script_add_states
+clutter_script_get_states
 
 <SUBSECTION>
 clutter_script_get_type_from_name



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]