some doc -> .h

SVN revision: 58412
This commit is contained in:
Carsten Haitzler 2011-04-07 10:38:25 +00:00
parent 9f011dfa0c
commit a55fbc4baa
2 changed files with 28 additions and 26 deletions

View File

@ -24,6 +24,26 @@
#include "eina_types.h"
#include "eina_magic.h"
/**
* @addtogroup Eina_Accessor_Group Accessor Functions
*
* @brief These functions manage accessor on containers.
*
* These functions allow to access elements of a container in a
* generic way, without knowing which container is used (a bit like
* iterators in the C++ STL). Accessors allows random access (that is, any
* element in the container). For sequential access, see
* @ref Eina_Iterator_Group.
*
* An accessor is created from container data types, so no creation
* function is available here. An accessor is deleted with
* eina_accessor_free(). To get the data of an element at a given
* position, use eina_accessor_data_get(). To call a function on
* chosen elements of a container, use eina_accessor_over().
*
* @{
*/
/**
* @addtogroup Eina_Content_Access_Group Content Access
*
@ -108,6 +128,14 @@ struct _Eina_Accessor
*/
#define FUNC_ACCESSOR_LOCK(Function) ((Eina_Accessor_Lock_Callback)Function)
/**
* @brief Free an accessor.
*
* @param accessor The accessor to free.
*
* This function frees @p accessor if it is not @c NULL;
*/
EAPI void eina_accessor_free(Eina_Accessor *accessor) EINA_ARG_NONNULL(1);
EAPI Eina_Bool eina_accessor_data_get(Eina_Accessor *accessor,
unsigned int position,

View File

@ -91,33 +91,7 @@ eina_accessor_shutdown(void)
* API *
*============================================================================*/
/**
* @addtogroup Eina_Accessor_Group Accessor Functions
*
* @brief These functions manage accessor on containers.
*
* These functions allow to access elements of a container in a
* generic way, without knowing which container is used (a bit like
* iterators in the C++ STL). Accessors allows random access (that is, any
* element in the container). For sequential access, see
* @ref Eina_Iterator_Group.
*
* An accessor is created from container data types, so no creation
* function is available here. An accessor is deleted with
* eina_accessor_free(). To get the data of an element at a given
* position, use eina_accessor_data_get(). To call a function on
* chosen elements of a container, use eina_accessor_over().
*
* @{
*/
/**
* @brief Free an accessor.
*
* @param accessor The accessor to free.
*
* This function frees @p accessor if it is not @c NULL;
*/
EAPI void
eina_accessor_free(Eina_Accessor *accessor)
{