brl/mutter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document what happens when self==descendant in clutter_actor_contains

Browse Source 
The documentation for clutter_actor_contains didn't specify what
happens when self==descendant. A strict reading of it might lead you
to think that it would return FALSE because in that case the
descendant isn't an immediate child or a deeper descendant. The code
actually would return TRUE. I think this is more useful so this patch
fixes the docs rather than the code.
This commit is contained in:
Neil Roberts 2010-09-27 17:47:38 +01:00
parent bba1424a44
commit 99adb88e9b
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
clutter/clutter-actor.c
View File

@ -7376,7 +7376,8 @@ clutter_actor_reparent (ClutterActor *self,
* @descendant: A #ClutterActor, possibly contained in @self
*
* Determines if @descendant is contained inside @self (either as an
* immediate child, or as a deeper descendant).
* immediate child, or as a deeper descendant). If @self and
* @descendant point to the same actor then it will also return %TRUE.
*
* Return value: whether @descendent is contained within @self
*