From c0e35c834c023f344a4c34abedefbaa81a147452 Mon Sep 17 00:00:00 2001 From: gastal Date: Wed, 6 Jul 2011 14:50:46 +0000 Subject: [PATCH] Eina: Improving eina_accessor documentation. git-svn-id: http://svn.enlightenment.org/svn/e/trunk/eina@61089 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33 --- src/include/eina_accessor.h | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/src/include/eina_accessor.h b/src/include/eina_accessor.h index 531e6a6..3ca8659 100644 --- a/src/include/eina_accessor.h +++ b/src/include/eina_accessor.h @@ -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); -- 2.7.4