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

Eina: Improving eina_accessor documentation. 

SVN revision: 61089
This commit is contained in:
Jonas M. Gastal 2011-07-06 14:50:46 +00:00
parent 6b3b2c15b5
commit d8d3e290be
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
legacy/eina/src/include/eina_accessor.h
View File

@ -247,10 +247,13 @@ EAPI void eina_accessor_over(Eina_Accessor *accessor,
* @param accessor The accessor.
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* If the container of the @p accessor permits it, it will be locked.
* If @p accessor is @c NULL or if a problem occurred, #EINA_FALSE is
* returned, otherwise #EINA_TRUE is returned. If the container
* is not lockable, it will return EINA_TRUE.
* If the container of the @p accessor permits it, it will be locked. When a
* container is locked calling eina_accessor_over() on it will return
* imediately. If @p accessor is @c NULL or if a problem occurred, #EINA_FALSE
* is returned, otherwise #EINA_TRUE is returned. If the container isn't
* lockable, it will return EINA_TRUE.
*
* @warning None of the existing eina data structures are lockable.
*/
EAPI Eina_Bool eina_accessor_lock(Eina_Accessor *accessor) EINA_ARG_NONNULL(1);
@ -265,6 +268,8 @@ EAPI Eina_Bool eina_accessor_lock(Eina_Accessor *accessor) EINA_ARG_NONNULL(1);
* problem occurred, #EINA_FALSE is returned, otherwise #EINA_TRUE
* is returned. If the container is not lockable, it will return
* EINA_TRUE.
*
* @warning None of the existing eina data structures are lockable.
*/
EAPI Eina_Bool eina_accessor_unlock(Eina_Accessor *accessor) EINA_ARG_NONNULL(1);