From 4dd3fa64004afb86fd53e873c68d0c39d89ca6ce Mon Sep 17 00:00:00 2001 From: Iain Holmes Date: Wed, 21 Jun 2006 23:19:59 +0000 Subject: [PATCH] Some more docs --- ChangeLog | 6 ++++++ clutter/clutter-stage.c | 10 +++++----- gtk/gtk-clutter.c | 8 ++++++++ 3 files changed, 19 insertions(+), 5 deletions(-) diff --git a/ChangeLog b/ChangeLog index c49e147ad..7b96174c8 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +2006-06-22 Iain Holmes + + * clutter/clutter-actor.c: + * clutter/clutter-stage.c: + * gtk/gtk-clutter.c: More docs + 2006-06-22 Iain Holmes * clutter/clutter-actor.c: Added some more docs. diff --git a/clutter/clutter-stage.c b/clutter/clutter-stage.c index e5b2fda2d..4b37a72c4 100644 --- a/clutter/clutter-stage.c +++ b/clutter/clutter-stage.c @@ -793,7 +793,7 @@ clutter_stage_get_default (void) * clutter_stage_get_xwindow * @stage: A #ClutterStage * - * Get the stages underlying x window ID. + * Get the stage's underlying x window ID. * * Return Value: Stage X Window XID **/ @@ -808,7 +808,7 @@ clutter_stage_get_xwindow (ClutterStage *stage) * @stage: A #ClutterStage * @xid: A preexisting X Window ID * - * Target the #ClutterStage to use an existing externtal X Window. + * Target the #ClutterStage to use an existing external X Window. * * Return Value: TRUE if foreign window valid, FALSE otherwise **/ @@ -862,9 +862,9 @@ clutter_stage_set_xwindow_foreign (ClutterStage *stage, * clutter_stage_get_xvisual * @stage: A #ClutterStage * - * Get the stages XVisualInfo. + * Get the stage's XVisualInfo. * - * Return Value: Thes Stages XVisualInfo + * Return Value: The stage's XVisualInfo **/ const XVisualInfo* clutter_stage_get_xvisual (ClutterStage *stage) @@ -905,7 +905,7 @@ clutter_stage_set_color (ClutterStage *stage, * @stage: A #ClutterStage * @color: return location for a #ClutterColor * - * Request the stage color. + * Retrieves the stage color. */ void clutter_stage_get_color (ClutterStage *stage, diff --git a/gtk/gtk-clutter.c b/gtk/gtk-clutter.c index d1f5fd914..a67676407 100644 --- a/gtk/gtk-clutter.c +++ b/gtk/gtk-clutter.c @@ -23,6 +23,14 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:gtk-clutter + * @short_description: GTK+ widget displaying a #ClutterStage. + * + * #GtkClutter is a GTK+ widget, derived from #GtkDrawingArea that contains a + * #ClutterStage, allowing it to be used in a GTK+ based program like any + * normal GTK+ widget. + */ #include "config.h" #include