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

Eobj: Updated weak ref docs. 

SVN revision: 70419
This commit is contained in:
Tom Hacohen 2012-04-23 12:47:44 +00:00
parent 31e6682a66
commit 331ef4b522
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
legacy/eobj/lib/Eobj.h
View File

@ -542,16 +542,25 @@ EAPI void eobj_del(Eobj *obj);
*/
/**
* @brief Create a new weak reference to obj.
* @brief Add a new weak reference to obj.
* @param obj The object being referenced.
* @param wref The pointer to use for the weak ref.
* @return The object being referenced (obj).
*
* This function registers the object handle pointed by wref to obj so when
* obj is deleted it'll be updated to NULL. This functions should be used
* when you want to keep track of an object in a safe way, but you don't want
* to prevent it from being freed.
*
* @see eobj_weak_ref_del()
*/
EAPI Eobj *eobj_weak_ref_add(const Eobj *obj, Eobj **wref);
/**
* @brief Free the weak reference passed.
* @brief Delete the weak reference passed.
* @param wref the weak reference to free.
*
* @see eobj_weak_ref_add()
*/
EAPI void eobj_weak_ref_del(Eobj **wref);