rggammon
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Eo base: Improve documentation.

This commit is contained in:
Tom Hacohen 2016-04-14 18:32:45 +01:00
parent 5a3af92e5b
commit ba4796d1b2
1 changed files with 16 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
src/lib/eo/eo_base.eo
View File

@ -49,17 +49,25 @@ abstract Eo.Base ()
methods {
@property parent {
set {
[[Set the parent of an object.
[[The parent of an object.
Parents keep references to their children so in order to
delete objects that have parents you need to set parent to
NULL or use eo_del() that does that for you (and also unrefs
the object).
]]
Parents keep references to their children so in order to
delete objects that have parents you need to set parent to
NULL or use eo_del() that does that for you (and also unrefs
the object).
The Eo parent is conceptually user set. That means that a parent
should not be changed behind the scenes in a surprising manner.
For example:
if you have a widget that has a box internally, and
when you swallow into that widget the object you swallow ends up in
the box, the parent should be the widget, and not the box.
]]
set {
}
get {
[[Get the parent of an object]]
}
values {
parent: Eo.Base * @nullable; [[the new parent]]