Some more docs

This commit is contained in:
Iain Holmes 2006-06-21 23:19:59 +00:00
parent 38980ad67f
commit 4dd3fa6400
3 changed files with 19 additions and 5 deletions

View File

@ -1,3 +1,9 @@
2006-06-22 Iain Holmes <iain@openedhand.com>
* clutter/clutter-actor.c:
* clutter/clutter-stage.c:
* gtk/gtk-clutter.c: More docs
2006-06-22 Iain Holmes <iain@openedhand.com>
* clutter/clutter-actor.c: Added some more docs.

View File

@ -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,

View File

@ -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 <gdk/gdkx.h>