cedric pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=d180f4991ba0b173cfabef12c23d970d92b6d9f4
commit d180f4991ba0b173cfabef12c23d970d92b6d9f4 Author: Srivardhan Hebbar <[email protected]> Date: Fri Mar 6 16:35:45 2015 +0100 eo: updated documentation of eo_add and eo_ref_add. Summary: Had a chat with raster to understand the behavior of these two functions in the IRC. Thought it might be helpful if added in the documentation itself. So updated it accordingly. Reviewers: cedric Subscribers: cedric Differential Revision: https://phab.enlightenment.org/D2083 Signed-off-by: Cedric BAIL <[email protected]> --- src/lib/eo/Eo.h | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/src/lib/eo/Eo.h b/src/lib/eo/Eo.h index 6cd8279..af78795 100644 --- a/src/lib/eo/Eo.h +++ b/src/lib/eo/Eo.h @@ -641,11 +641,15 @@ EAPI void eo_error_set_internal(const Eo *obj, const char *file, int line); /** * @def eo_add - * @brief Create a new object with the default constructor. + * @brief Create a new object and call its constructor(If it exits). * - * The object returned by this function always has at least 1 ref. If the object - * has a parent, it returns with 1 ref, and even if it doesn't have a parent - * it's returned with 1 ref. This is convenient in C. + * The object returned by this function will always have 1 ref + * (reference count) irrespective of whether the parent is NULL or + * not. + * If the object is created using this function, then it would + * automatically gets deleted when the parent object is deleted. + * There is no need to call eo_unref on the child. This is convenient + * in C. * * If you want a more "consistent" behaviour, take a look at #eo_add_ref. * @@ -658,10 +662,13 @@ EAPI void eo_error_set_internal(const Eo *obj, const char *file, int line); /** * @def eo_add_ref - * @brief Create a new object with the default constructor. + * @brief Create a new object and call its constructor(If it exists). * * The object returned by this function has 1 ref for itself, 1 ref from the * parent (if exists) and possible other refs if were added during construction. + * If a child object is created using this, then it won't get deleted + * when the parent object is deleted until you manually remove the ref + * by calling eo_unref(). * * @param klass the class of the object to create. * @param parent the parent to set to the object. --
