From f4eee9ad3a5b713ff526dae22745d6118d9700ab Mon Sep 17 00:00:00 2001 From: Iain Holmes Date: Wed, 21 Jun 2006 23:02:20 +0000 Subject: [PATCH] Some more docs --- ChangeLog | 4 ++++ clutter/clutter-actor.c | 21 +++++++++++++-------- doc/reference/tmpl/clutter-main.sgml | 1 + 3 files changed, 18 insertions(+), 8 deletions(-) diff --git a/ChangeLog b/ChangeLog index f5bbfcfa8..c49e147ad 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2006-06-22 Iain Holmes + + * clutter/clutter-actor.c: Added some more docs. + 2006-06-22 Matthew Allum * clutter/clutter-actor.c: diff --git a/clutter/clutter-actor.c b/clutter/clutter-actor.c index 1f33205af..55fed053d 100644 --- a/clutter/clutter-actor.c +++ b/clutter/clutter-actor.c @@ -935,7 +935,7 @@ clutter_actor_get_name (ClutterActor *self) * clutter_actor_get_id: * @self: A #ClutterActor * - * FIXME + * Retrieves the unique id for @self. * * Return value: Globally unique value for object instance. */ @@ -950,9 +950,9 @@ clutter_actor_get_id (ClutterActor *self) /** * clutter_actor_set_depth: * @self: a #ClutterActor - * @depth: FIXME + * @depth: Z co-ord * - * FIXME ( Basically sets Z value ) + * Sets the Z co-ordinate of @self to @depth. */ void clutter_actor_set_depth (ClutterActor *self, @@ -1084,10 +1084,10 @@ clutter_actor_mirror (ClutterActor *self, /** * clutter_actor_set_clip: * @self: A #ClutterActor - * @xoff: FIXME - * @yoff: FIXME - * @width: FIXME - * @height: FIXME + * @xoff: X offset of the clip rectangle + * @yoff: Y offset of the clip rectangle + * @width: Width of the clip rectangle + * @height: Height of the clip rectangle * * Sets clip area for @self. */ @@ -1131,6 +1131,7 @@ clutter_actor_remove_clip (ClutterActor *self) * @self: A #ClutterActor * @parent: A new #ClutterActor parent or NULL * + * Sets the parent of @self to @parent. * This function should not be used by applications. */ void @@ -1156,6 +1157,8 @@ clutter_actor_set_parent (ClutterActor *self, * clutter_actor_get_parent: * @self: A #ClutterActor * + * Retrieves the parent of @self. + * * Return Value: The #ClutterActor parent or NULL */ ClutterActor* @@ -1169,6 +1172,7 @@ clutter_actor_get_parent (ClutterActor *self) * @self: A #ClutterActor * @below: A #ClutterActor to raise above. * + * Puts @self above @below. * Both actors must have the same parent. */ void @@ -1187,6 +1191,7 @@ clutter_actor_raise (ClutterActor *self, ClutterActor *below) * @self: A #ClutterActor * @above: A #ClutterActor to lower below * + * Puts @self below @above. * Both actors must have the same parent. */ void @@ -1212,7 +1217,7 @@ clutter_actor_lower (ClutterActor *self, ClutterActor *above) * clutter_actor_rise_top: * @self: A #ClutterActor * - * Rises @self to the top. + * Raises @self to the top. */ void clutter_actor_raise_top (ClutterActor *self) diff --git a/doc/reference/tmpl/clutter-main.sgml b/doc/reference/tmpl/clutter-main.sgml index c1522fec4..a36482264 100644 --- a/doc/reference/tmpl/clutter-main.sgml +++ b/doc/reference/tmpl/clutter-main.sgml @@ -55,6 +55,7 @@ clutter-main @a...: @a...: @a...: +@a...: @a...: