isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-12-22 19:12:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Some more docs

Browse Source
This commit is contained in:
Iain Holmes 2006-06-21 23:02:20 +00:00
parent c39b868aeb
commit f4eee9ad3a
3 changed files with 18 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
ChangeLog
View File

@ -1,3 +1,7 @@
2006-06-22 Iain Holmes <iain@openedhand.com>
* clutter/clutter-actor.c: Added some more docs.
2006-06-22 Matthew Allum <mallum@openedhand.com> 2006-06-22 Matthew Allum <mallum@openedhand.com>
* clutter/clutter-actor.c: * clutter/clutter-actor.c:

21
clutter/clutter-actor.c
View File

@ -935,7 +935,7 @@ clutter_actor_get_name (ClutterActor *self)
* clutter_actor_get_id: * clutter_actor_get_id:
* @self: A #ClutterActor * @self: A #ClutterActor
* *
* FIXME * Retrieves the unique id for @self.
* *
* Return value: Globally unique value for object instance. * Return value: Globally unique value for object instance.
*/ */
@ -950,9 +950,9 @@ clutter_actor_get_id (ClutterActor *self)
/** /**
* clutter_actor_set_depth: * clutter_actor_set_depth:
* @self: a #ClutterActor * @self: a #ClutterActor
* @depth: FIXME * @depth: Z co-ord
* *
* FIXME ( Basically sets Z value ) * Sets the Z co-ordinate of @self to @depth.
*/ */
void void
clutter_actor_set_depth (ClutterActor *self, clutter_actor_set_depth (ClutterActor *self,
@ -1084,10 +1084,10 @@ clutter_actor_mirror (ClutterActor *self,
/** /**
* clutter_actor_set_clip: * clutter_actor_set_clip:
* @self: A #ClutterActor * @self: A #ClutterActor
* @xoff: FIXME * @xoff: X offset of the clip rectangle
* @yoff: FIXME * @yoff: Y offset of the clip rectangle
* @width: FIXME * @width: Width of the clip rectangle
* @height: FIXME * @height: Height of the clip rectangle
* *
* Sets clip area for @self. * Sets clip area for @self.
*/ */
@ -1131,6 +1131,7 @@ clutter_actor_remove_clip (ClutterActor *self)
* @self: A #ClutterActor * @self: A #ClutterActor
* @parent: A new #ClutterActor parent or NULL * @parent: A new #ClutterActor parent or NULL
* *
* Sets the parent of @self to @parent.
* This function should not be used by applications. * This function should not be used by applications.
*/ */
void void
@ -1156,6 +1157,8 @@ clutter_actor_set_parent (ClutterActor *self,
* clutter_actor_get_parent: * clutter_actor_get_parent:
* @self: A #ClutterActor * @self: A #ClutterActor
* *
* Retrieves the parent of @self.
*
* Return Value: The #ClutterActor parent or NULL * Return Value: The #ClutterActor parent or NULL
*/ */
ClutterActor* ClutterActor*
@ -1169,6 +1172,7 @@ clutter_actor_get_parent (ClutterActor *self)
* @self: A #ClutterActor * @self: A #ClutterActor
* @below: A #ClutterActor to raise above. * @below: A #ClutterActor to raise above.
* *
* Puts @self above @below.
* Both actors must have the same parent. * Both actors must have the same parent.
*/ */
void void
@ -1187,6 +1191,7 @@ clutter_actor_raise (ClutterActor *self, ClutterActor *below)
* @self: A #ClutterActor * @self: A #ClutterActor
* @above: A #ClutterActor to lower below * @above: A #ClutterActor to lower below
* *
* Puts @self below @above.
* Both actors must have the same parent. * Both actors must have the same parent.
*/ */
void void
@ -1212,7 +1217,7 @@ clutter_actor_lower (ClutterActor *self, ClutterActor *above)
* clutter_actor_rise_top: * clutter_actor_rise_top:
* @self: A #ClutterActor * @self: A #ClutterActor
* *
* Rises @self to the top. * Raises @self to the top.
*/ */
void void
clutter_actor_raise_top (ClutterActor *self) clutter_actor_raise_top (ClutterActor *self)

1
doc/reference/tmpl/clutter-main.sgml
View File

@ -56,6 +56,7 @@ clutter-main
@a...: @a...:
@a...: @a...:
@a...: @a...:
@a...:
<!-- ##### MACRO CLUTTER_GLERR ##### --> <!-- ##### MACRO CLUTTER_GLERR ##### -->