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

eina: doxygen doc fixes 

A #link at the beginning of a new line goes interpreted by doxygen as a title,
so format the documentation to avoid this issue. No content change.


SVN revision: 71501
This commit is contained in:
Jerome Pinot 2012-05-29 11:33:07 +00:00
parent 054360207b
commit b3e92d38b0
22 changed files with 261 additions and 274 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -203,8 +203,8 @@ EAPI void eina_accessor_free(Eina_Accessor *accessor) EINA_ARG_NONNULL(1);
*
* This function retrieves the data of the element pointed by
* @p accessor at the porition @p position, and stores it in
* @p data. If @p accessor is @c NULL or if an error occurred,
* #EINA_FALSE is returned, otherwise EINA_TRUE is returned.
* @p data. If @p accessor is @c NULL or if an error occurred, #EINA_FALSE
* is returned, otherwise #EINA_TRUE is returned.
*/
EAPI Eina_Bool eina_accessor_data_get(Eina_Accessor *accessor,
unsigned int position,

8
legacy/eina/src/include/eina_array.h
View File

@ -253,8 +253,8 @@ struct _Eina_Array
* another element will increase the buffer by @p step elements again.
*
* This function return a valid array on success, or @c NULL if memory
* allocation fails. In that case, the error is set to
* #EINA_ERROR_OUT_OF_MEMORY.
* allocation fails. In that case, the error is set
* to #EINA_ERROR_OUT_OF_MEMORY.
*/
EAPI Eina_Array *eina_array_new(unsigned int step) EINA_WARN_UNUSED_RESULT EINA_MALLOC EINA_WARN_UNUSED_RESULT;
@ -265,8 +265,8 @@ EAPI Eina_Array *eina_array_new(unsigned int step) EINA_WARN_UNUSED_RESULT EINA_
*
* This function frees @p array. It calls first eina_array_flush() then
* free the memory of the pointer. It does not free the memory
* allocated for the elements of @p array. To free them, use
* #EINA_ARRAY_ITER_NEXT. For performance reasons, there is no check
* allocated for the elements of @p array. To free them,
* use #EINA_ARRAY_ITER_NEXT. For performance reasons, there is no check
* of @p array.
*/
EAPI void eina_array_free(Eina_Array *array) EINA_ARG_NONNULL(1);

4
legacy/eina/src/include/eina_benchmark.h
View File

@ -365,8 +365,8 @@ typedef void (*Eina_Benchmark_Specimens)(int request);
* to name the gnuplot file that eina_benchmark_run() will create.
*
* This function return a valid benchmark on success, or @c NULL if
* memory allocation fails. In that case, the error is set to
* #EINA_ERROR_OUT_OF_MEMORY.
* memory allocation fails. In that case, the error is set
* to #EINA_ERROR_OUT_OF_MEMORY.
*
* When the new module is not needed anymore, use
* eina_benchmark_free() to free the allocated memory.

4
legacy/eina/src/include/eina_binbuf.h
View File

@ -115,8 +115,8 @@ EAPI Eina_Bool eina_binbuf_append_length(Eina_Binbuf *buf, const unsigned char *
* @param c The char to append.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* This function inserts @p c to @p buf. If it can not insert it,
* #EINA_FALSE is returned, otherwise #EINA_TRUE is returned.
* This function inserts @p c to @p buf. If it can not insert it, #EINA_FALSE
* is returned, otherwise #EINA_TRUE is returned.
*/
EAPI Eina_Bool eina_binbuf_append_char(Eina_Binbuf *buf, unsigned char c) EINA_ARG_NONNULL(1);

32
legacy/eina/src/include/eina_hash.h
View File

@ -329,8 +329,8 @@ typedef Eina_Bool (*Eina_Hash_Foreach)(const Eina_Hash *hash, const void *key
* @return The new hash table.
*
* This function creates a new hash table using user-defined callbacks
* to manage the hash table. On failure, @c NULL is returned and
* #EINA_ERROR_OUT_OF_MEMORY is set. If @p key_cmp_cb or @p key_hash_cb
* to manage the hash table. On failure, @c NULL is returned
* and #EINA_ERROR_OUT_OF_MEMORY is set. If @p key_cmp_cb or @p key_hash_cb
* are @c NULL, @c NULL is returned. If @p buckets_power_size is
* smaller or equal than 2, or if it is greater or equal than 17,
* @c NULL is returned.
@ -561,8 +561,8 @@ EAPI Eina_Bool eina_hash_direct_add(Eina_Hash *hash,
* This function removes the entry identified by @p key or @p data
* from @p hash. If a free function was given to the
* callback on creation, it will be called for the data being
* deleted. If @p hash is @c NULL, the functions returns immediately
* #EINA_FALSE. If @p key is @c NULL, then @p data is used to find the a
* deleted. If @p hash is @c NULL, the functions returns immediately #EINA_FALSE.
* If @p key is @c NULL, then @p data is used to find the a
* match to remove, otherwise @p key is used and @p data is not
* required and can be @c NULL. This function returns #EINA_FALSE if
* an error occurred, #EINA_TRUE otherwise.
@ -778,8 +778,8 @@ EAPI Eina_Bool eina_hash_direct_add_by_hash(Eina_Hash *hash,
* callback on creation, it will be called for the data being
* deleted. Do not forget to count '\\0' for string when setting the
* value of @p key_length. If @p hash or @p key are @c NULL, the
* functions returns immediately #EINA_FALSE. This function returns
* #EINA_FALSE if an error occurred, #EINA_TRUE otherwise.
* functions returns immediately #EINA_FALSE. This function
* returns #EINA_FALSE if an error occurred, #EINA_TRUE otherwise.
*
* @note if you don't have the key_hash, use eina_hash_del_by_key() instead.
* @note if you don't have the key, use eina_hash_del_by_data() instead.
@ -804,8 +804,8 @@ EAPI Eina_Bool eina_hash_del_by_key_hash(Eina_Hash *hash,
* using functiond provided to has creation function. If a free
* function was given to the callback on creation, it will be called
* for the data being deleted. If @p hash or @p key are @c NULL, the
* functions returns immediately #EINA_FALSE. This function returns
* #EINA_FALSE if an error occurred, #EINA_TRUE otherwise.
* functions returns immediately #EINA_FALSE. This function
* returns #EINA_FALSE if an error occurred, #EINA_TRUE otherwise.
*
* @note if you already have the key_hash, use eina_hash_del_by_key_hash()
* instead.
@ -854,8 +854,8 @@ EAPI Eina_Bool eina_hash_del_by_data(Eina_Hash *hash,
* This function removes the entry identified by @p key and
* @p key_hash, or @p data, from @p hash. If a free function was given to
* the callback on creation, it will be called for the data being
* deleted. If @p hash is @c NULL, the functions returns immediately
* #EINA_FALSE. If @p key is @c NULL, then @p key_length and @p key_hash
* deleted. If @p hash is @c NULL, the functions returns immediately #EINA_FALSE.
* If @p key is @c NULL, then @p key_length and @p key_hash
* are ignored and @p data is used to find a match to remove,
* otherwise @p key and @p key_hash are used and @p data is not
* required and can be @c NULL. Do not forget to count '\\0' for
@ -926,8 +926,8 @@ EAPI void *eina_hash_modify_by_hash(Eina_Hash *hash,
* valid iterator that will always return false on
* eina_iterator_next(), thus keeping API sane.
*
* If the memory can not be allocated, NULL is returned and
* #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
* If the memory can not be allocated, NULL is returned
* and #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
* returned.
*
* @warning if the hash structure changes then the iterator becomes
@ -947,8 +947,8 @@ EAPI Eina_Iterator *eina_hash_iterator_key_new(const Eina_Hash *hash) EINA_MALLO
* valid iterator that will always return false on
* eina_iterator_next(), thus keeping API sane.
*
* If the memory can not be allocated, @c NULL is returned and
* #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
* If the memory can not be allocated, @c NULL is returned
* and #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
* returned.
*
* @warning if the hash structure changes then the iterator becomes
@ -968,8 +968,8 @@ EAPI Eina_Iterator *eina_hash_iterator_data_new(const Eina_Hash *hash) EINA_MALL
* valid iterator that will always return false on
* eina_iterator_next(), thus keeping API sane.
*
* If the memory can not be allocated, NULL is returned and
* #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
* If the memory can not be allocated, NULL is returned
* and #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
* returned.
*
* @note iterator data will provide values as Eina_Hash_Tuple that should not

19
legacy/eina/src/include/eina_inarray.h
View File

@ -558,10 +558,9 @@ EAPI int eina_inarray_search_sorted(const Eina_Inarray *array,
*
* Call @a function for every given data in @a array.
*
* Safe way to iterate over an array. @p function should return
* #EINA_TRUE as long as you want the function to continue iterating,
* by returning #EINA_FALSE it will stop and return #EINA_FALSE as a
* result.
* Safe way to iterate over an array. @p function should return #EINA_TRUE
* as long as you want the function to continue iterating, by
* returning #EINA_FALSE it will stop and return #EINA_FALSE as a result.
*
* The data given to @a function are the pointer to member memory
* itself.
@ -607,8 +606,8 @@ EAPI unsigned int eina_inarray_count(const Eina_Inarray *array) EINA_ARG_NONNULL
* This function returns a newly allocated iterator associated to
* @p array.
*
* If the memory can not be allocated, NULL is returned and
* #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
* If the memory can not be allocated, NULL is returned
* and #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
* returned.
*
* @warning if the array structure changes then the iterator becomes
@ -629,8 +628,8 @@ EAPI Eina_Iterator *eina_inarray_iterator_new(const Eina_Inarray *array) EINA_MA
*
* Unlike eina_inarray_iterator_new(), this will walk the array backwards.
*
* If the memory can not be allocated, NULL is returned and
* #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
* If the memory can not be allocated, NULL is returned
* and #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
* returned.
*
* @warning if the array structure changes then the iterator becomes
@ -649,8 +648,8 @@ EAPI Eina_Iterator *eina_inarray_iterator_reversed_new(const Eina_Inarray *array
* This function returns a newly allocated accessor associated to
* @p array.
*
* If the memory can not be allocated, NULL is returned and
* #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid accessor is
* If the memory can not be allocated, NULL is returned
* and #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid accessor is
* returned.
*
* @since 1.2

4
legacy/eina/src/include/eina_inline_array.x
View File

@ -51,8 +51,8 @@ EAPI Eina_Bool eina_array_grow(Eina_Array *array);
* This function appends @p data to @p array. For performance
* reasons, there is no check of @p array. If it is @c NULL or
* invalid, the program may crash. If @p data is @c NULL, or if an
* allocation is necessary and fails, #EINA_FALSE is returned and
* #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, #EINA_TRUE is
* allocation is necessary and fails, #EINA_FALSE is returned
* and #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, #EINA_TRUE is
* returned.
*/

18
legacy/eina/src/include/eina_inline_lock_void.x
View File

@ -56,8 +56,8 @@ typedef void *Eina_Semaphore;
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* This function creates a new #Eina_Lock object and stores it in the
* @p mutex buffer. On success, this function returns #EINA_TRUE and
* #EINA_FALSE otherwise. To free the resources allocated by this
* @p mutex buffer. On success, this function returns #EINA_TRUE
* and #EINA_FALSE otherwise. To free the resources allocated by this
* function, use eina_lock_free(). For performance reasons, no check
* is done on @p mutex.
*/
@ -88,8 +88,8 @@ eina_lock_free(Eina_Lock *mutex EINA_UNUSED)
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* This function locks @p mutex. @p mutex must have been created by
* eina_lock_new(). On success, this function returns #EINA_TRUE and
* #EINA_FALSE otherwise. For performance reasons, no check is done on
* eina_lock_new(). On success, this function returns #EINA_TRUE
* and #EINA_FALSE otherwise. For performance reasons, no check is done on
* @p mutex.
*/
static inline Eina_Lock_Result
@ -105,8 +105,8 @@ eina_lock_take(Eina_Lock *mutex EINA_UNUSED)
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* This function tries to lock @p mutex. @p mutex must have been created by
* eina_lock_new(). If @p mutex can be locked, this function returns
* #EINA_TRUE; if @p mutex can not be locked, or is already locked, it
* eina_lock_new(). If @p mutex can be locked, this function returns #EINA_TRUE;
* if @p mutex can not be locked, or is already locked, it
* returns #EINA_FALSE. This function does not block and returns
* immediately. For performance reasons, no check is done on
* @p mutex.
@ -126,9 +126,9 @@ eina_lock_take_try(Eina_Lock *mutex EINA_UNUSED)
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* This function unlocks @p mutex. @p mutex must have been created by
* eina_lock_new(). On success, this function returns #EINA_TRUE and
* #EINA_FALSE otherwise. For performance reasons, no check is done on
* @p mutex.
* eina_lock_new(). On success, this function returns #EINA_TRUE
* and #EINA_FALSE otherwise. For performance reasons, no check is
* done on @p mutex.
*/
static inline Eina_Lock_Result
eina_lock_release(Eina_Lock *mutex EINA_UNUSED)

10
legacy/eina/src/include/eina_inline_rectangle.x
View File

@ -36,8 +36,8 @@
* @param l2 The length of the second span.
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* This function returns #EINA_TRUE if the given spans intersect,
* #EINA_FALSE otherwise.
* This function returns #EINA_TRUE if the given spans intersect, #EINA_FALSE
* otherwise.
*/
static inline int
eina_spans_intersect(int c1, int l1, int c2, int l2)
@ -90,9 +90,9 @@ eina_rectangle_coords_from(Eina_Rectangle *r, int x, int y, int w, int h)
* @param r2 The second rectangle.
* @return #EINA_TRUE if the rectangles intersect, #EINA_FALSE otherwise.
*
* This function returns #EINA_TRUE if @p r1 and @p r2 intersect,
* #EINA_FALSE otherwise. No check is done on @p r1 and @p r2, so they
* must be valid rectangles.
* This function returns #EINA_TRUE if @p r1 and @p r2 intersect, #EINA_FALSE
* otherwise. No check is done on @p r1 and @p r2, so they must be valid
* rectangles.
*/
static inline Eina_Bool
eina_rectangles_intersect(const Eina_Rectangle *r1, const Eina_Rectangle *r2)

6
legacy/eina/src/include/eina_inlist.h
View File

@ -612,9 +612,9 @@ EAPI unsigned int eina_inlist_count(const Eina_Inlist *list) EINA_WARN_UNUSED_
* will always return false on eina_iterator_next(), thus keeping API
* sane.
*
* If the memory can not be allocated, NULL is returned and
* #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
* returned.
* If the memory can not be allocated, @c NULL is returned
* and #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator
* is returned.
*
* @warning if the list structure changes then the iterator becomes
* invalid, and if you add or remove nodes iterator

12
legacy/eina/src/include/eina_list.h
View File

@ -1292,9 +1292,9 @@ static inline unsigned int eina_list_count(const Eina_List *list) EINA_PURE;
* will always return false on eina_iterator_next(), thus keeping API
* sane.
*
* If the memory can not be allocated, NULL is returned and
* #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
* returned.
* If the memory can not be allocated, NULL is returned
* and #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator
* is returned.
*
* @warning @p list must be a pointer to the first element of the list.
*
@ -1319,9 +1319,9 @@ EAPI Eina_Iterator *eina_list_iterator_new(const Eina_List *list) EINA_MA
*
* Unlike eina_list_iterator_new(), this will walk the list backwards.
*
* If the memory can not be allocated, NULL is returned and
* #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
* returned.
* If the memory can not be allocated, NULL is returned
* and #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator
* is returned.
*
* @warning @p list must be a pointer to the first element of the list.
*

4
legacy/eina/src/include/eina_magic.h
View File

@ -232,8 +232,8 @@ EAPI extern Eina_Error EINA_ERROR_MAGIC_FAILED;
/**
* @def EINA_MAGIC_SET(d, m)
* Set the magic number of @p d to @p m. @p d must be a valid pointer
* to a structure holding an Eina magic number declaration. Use
* #EINA_MAGIC to add such declaration.
* to a structure holding an Eina magic number declaration.
* Use #EINA_MAGIC to add such declaration.
*
* If the magic feature of Eina is disabled, #EINA_MAGIC_CHECK is just
* the value @c 0.

220
legacy/eina/src/include/eina_model.h
View File

@ -285,8 +285,8 @@
* Not as generic as #EINA_MODEL_TYPE_GENERIC, but way more efficient
* is #EINA_MODEL_TYPE_STRUCT that instead of a hash of properties of
* any type, it uses a struct to map properties. Its properties are
* fixed set of names and they have fixed type, as defined by the
* #Eina_Value_Struct_Desc description used internally.
* fixed set of names and they have fixed type, as defined by
* the #Eina_Value_Struct_Desc description used internally.
*
* Examples:
* @li @ref eina_model_01_c inheritance example, uses #EINA_MODEL_TYPE_GENERIC
@ -294,8 +294,8 @@
* example that demonstrates several of the important features of
* eina_model, uses #EINA_MODEL_TYPE_GENERIC.
* @li @ref eina_model_03_example_page walk-through example on how to
* inherit types, a suggestion of eina_model_load() usage and uses
* #EINA_MODEL_TYPE_STRUCT.
* inherit types, a suggestion of eina_model_load() usage and
* uses #EINA_MODEL_TYPE_STRUCT.
* @li @ref eina_model_04_c Advanced inheritance, interfaces and interface
* function overloading example.
*
@ -520,9 +520,9 @@ EAPI void eina_model_xunref(Eina_Model *model,
* @defgroup Eina_Model_Event_Group Data Model Events
* Events and their usage with models.
*
* Events are specified by each type and interface level using
* #Eina_Model_Event_Description. One can know all events supported by
* a model with eina_model_event_names_list_get() and then
* Events are specified by each type and interface level
* using #Eina_Model_Event_Description. One can know all events supported
* by a model with eina_model_event_names_list_get() and then
* eina_model_event_description_get() to retrieve details.
*
* By default the following events are supported in every object:
@ -747,8 +747,8 @@ EAPI Eina_Bool eina_model_load(Eina_Model *model) EINA_ARG_NONNULL(1);
* by user defined types can be given.
*
* @note The types provided by Eina_Model don't implement this method.
* @note Calling this function on a model that doesn't implement it returns @c
* EINA_TRUE without any effect on @a model.
* @note Calling this function on a model that doesn't implement it
* returns #EINA_TRUE without any effect on @a model.
*
* @see eina_model_load()
* @since 1.2
@ -774,9 +774,7 @@ EAPI Eina_Bool eina_model_unload(Eina_Model *model) EINA_ARG_NONNULL(1);
* @param[in] model The model from which to get the property.
* @param[in] name The name of the property whose value is wanted.
* @param[out] value A pointer to an Eina_Value to receive the property's value.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @return EINA_TRUE if @a model has a property named @a name, EINA_FALSE
* @return #EINA_TRUE if @a model has a property named @a name, #EINA_FALSE
* otherwise.
*
* @see eina_model_property_set()
@ -1357,8 +1355,8 @@ EAPI char *eina_model_to_string(const Eina_Model *model) EINA_ARG_NONNULL(1) EIN
* order. Whenever they do not exist, their parent pointer is
* called.
* @note a runtime check will enforce just types with ABI version
* #EINA_MODEL_TYPE_VERSION are used by comparing with the @c version
* member.
* version #EINA_MODEL_TYPE_VERSION are used by comparing with
* the @c version member.
*
* @since 1.2
*/
@ -1562,8 +1560,8 @@ struct _Eina_Model_Type
* @note You should only do your type's initialization after the parent type has
* done his own(this is as to ensure you can call on your parent's methods).
*
* @warning If model doesn't inherit from(or is of) @a type does nothing and
* returns EINA_FALSE.
* @warning If model doesn't inherit from (or is of) @a type does nothing and
* returns #EINA_FALSE.
*
* @see eina_model_new()
* @see _Eina_Model_Type
@ -1591,8 +1589,8 @@ EAPI Eina_Bool eina_model_type_constructor(const Eina_Model_Type *type,
* @note It's considered good practice to free your type's resources before
* calling the parent's destructor.
*
* @warning If model doesn't inherit from(or is of) @a type does nothing and
* returns EINA_FALSE.
* @warning If model doesn't inherit from (or is of) @a type does nothing and
* returns #EINA_FALSE.
*
* @see eina_model_del()
* @see _Eina_Model_Type
@ -1607,8 +1605,8 @@ EAPI Eina_Bool eina_model_type_destructor(const Eina_Model_Type *type,
* @param dst Pointer to where copy will be put.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If model doesn't inherit from(or is of) @a type does nothing and
* returns EINA_FALSE.
* @warning If model doesn't inherit from (or is of) @a type does nothing and
* returns #EINA_FALSE.
*
* @see eina_model_copy()
* @see _Eina_Model_Type
@ -1624,8 +1622,8 @@ EAPI Eina_Bool eina_model_type_copy(const Eina_Model_Type *type,
* @param dst Pointer to where copy will be put.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If model doesn't inherit from(or is of) @a type does nothing and
* returns EINA_FALSE.
* @warning If model doesn't inherit from (or is of) @a type does nothing and
* returns #EINA_FALSE.
*
* @see eina_model_deep_copy()
* @see _Eina_Model_Type
@ -1643,8 +1641,8 @@ EAPI Eina_Bool eina_model_type_deep_copy(const Eina_Model_Type *type,
* -1 if @a b is smaller than @a a, 0 if @a a and @a b are equal.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If model doesn't inherit from(or is of) @a type does nothing and
* returns EINA_FALSE.
* @warning If model doesn't inherit from (or is of) @a type does nothing and
* returns #EINA_FALSE.
*
* @see eina_model_compare()
* @see _Eina_Model_Type
@ -1660,8 +1658,8 @@ EAPI Eina_Bool eina_model_type_compare(const Eina_Model_Type *type,
* @param model The model instance.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If model doesn't inherit from(or is of) @a type does nothing and
* returns EINA_FALSE.
* @warning If model doesn't inherit from (or is of) @a type does nothing and
* returns #EINA_FALSE.
*
* @see eina_model_load()
* @see _Eina_Model_Type
@ -1675,8 +1673,8 @@ EAPI Eina_Bool eina_model_type_load(const Eina_Model_Type *type,
* @param model The model instance.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If model doesn't inherit from(or is of) @a type does nothing and
* returns EINA_FALSE.
* @warning If model doesn't inherit from (or is of) @a type does nothing and
* returns #EINA_FALSE.
*
* @see eina_model_unload()
* @see _Eina_Model_Type
@ -1690,10 +1688,10 @@ EAPI Eina_Bool eina_model_type_unload(const Eina_Model_Type *type,
* @param[in] model The model instance.
* @param[in] name Name of property to get.
* @param[out] value Pointer to where value of property will be placed.
* @return EINA_TRUE if able to get property, EINA_FALSE otherwise.
* @return #EINA_TRUE if able to get property, #EINA_FALSE otherwise.
*
* @warning If model doesn't inherit from(or is of) @a type does nothing and
* returns EINA_FALSE.
* @warning If model doesn't inherit from (or is of) @a type does nothing and
* returns #EINA_FALSE.
*
* @see eina_model_property_get()
* @see _Eina_Model_Type
@ -1711,8 +1709,8 @@ EAPI Eina_Bool eina_model_type_property_get(const Eina_Model_Type *type,
* @param value The value to be set.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If model doesn't inherit from(or is of) @a type does nothing and
* returns EINA_FALSE.
* @warning If model doesn't inherit from (or is of) @a type does nothing and
* returns #EINA_FALSE.
*
* @see eina_model_property_set()
* @see _Eina_Model_Type
@ -1729,8 +1727,8 @@ EAPI Eina_Bool eina_model_type_property_set(const Eina_Model_Type *type,
* @param name The name of the property to be deleted.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If model doesn't inherit from(or is of) @a type does nothing and
* returns EINA_FALSE.
* @warning If model doesn't inherit from (or is of) @a type does nothing and
* returns #EINA_FALSE.
*
* @see eina_model_property_del()
* @see _Eina_Model_Type
@ -1745,8 +1743,8 @@ EAPI Eina_Bool eina_model_type_property_del(const Eina_Model_Type *type,
* @param model The model instance.
* @return #Eina_List of properties' names.
*
* @warning If model doesn't inherit from(or is of) @a type does nothing and
* returns EINA_FALSE.
* @warning If model doesn't inherit from (or is of) @a type does nothing and
* returns #EINA_FALSE.
*
* @see eina_model_properties_names_list_get()
* @see _Eina_Model_Type
@ -1760,8 +1758,8 @@ EAPI Eina_List *eina_model_type_properties_names_list_get(const Eina_Model_Type
* @param model The model instance.
* @return Number of children in @a model.
*
* @warning If model doesn't inherit from(or is of) @a type does nothing and
* returns EINA_FALSE.
* @warning If model doesn't inherit from (or is of) @a type does nothing and
* returns #EINA_FALSE.
*
* @see eina_model_child_count()
* @see _Eina_Model_Type
@ -1776,8 +1774,8 @@ EAPI int eina_model_type_child_count(const Eina_Model_Type *type,
* @param position The position of the child to get.
* @return The child model, or NULL on failure.
*
* @warning If model doesn't inherit from(or is of) @a type does nothing and
* returns EINA_FALSE.
* @warning If model doesn't inherit from (or is of) @a type does nothing and
* returns #EINA_FALSE.
*
* @see eina_model_child_get()
* @see _Eina_Model_Type
@ -1791,10 +1789,10 @@ EAPI Eina_Model *eina_model_type_child_get(const Eina_Model_Type *type,
* @param type The type whose child set method will be called.
* @param model The model instance.
* @param position The position of the child to be set.
* @param child Pointer to value(child) to be set.
* @param child Pointer to value (child) to be set.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If model doesn't inherit from(or is of) @a type does nothing and
* @warning If model doesn't inherit from (or is of) @a type does nothing and
* returns EINA_FALSE.
*
* @see eina_model_child_set()
@ -1812,8 +1810,8 @@ EAPI Eina_Bool eina_model_type_child_set(const Eina_Model_Type *type,
* @param position Position of child to be deleted.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If model doesn't inherit from(or is of) @a type does nothing and
* returns EINA_FALSE.
* @warning If model doesn't inherit from (or is of) @a type does nothing and
* returns #EINA_FALSE.
*
* @see eina_model_child_del()
* @see _Eina_Model_Type
@ -1830,8 +1828,8 @@ EAPI Eina_Bool eina_model_type_child_del(const Eina_Model_Type *type,
* @param child The child to be inserted.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If model doesn't inherit from(or is of) @a type does nothing and
* returns EINA_FALSE.
* @warning If model doesn't inherit from (or is of) @a type does nothing and
* returns #EINA_FALSE.
*
* @see eina_model_child_insert_at()
* @see _Eina_Model_Type
@ -1849,8 +1847,8 @@ EAPI Eina_Bool eina_model_type_child_insert_at(const Eina_Model_Type *type,
* @param other The child being searched for.
* @return The index of the searched child, or -1 if not found.
*
* @warning If model doesn't inherit from(or is of) @a type does nothing and
* returns EINA_FALSE.
* @warning If model doesn't inherit from (or is of) @a type does nothing and
* returns #EINA_FALSE.
*
* @see eina_model_child_find()
* @see _Eina_Model_Type
@ -1870,8 +1868,8 @@ EAPI int eina_model_type_child_find(const Eina_Model_Type *type,
* @return The position of the first child to match the criteria or -1 if no
* child matches it.
*
* @warning If model doesn't inherit from(or is of) @a type does nothing and
* returns EINA_FALSE.
* @warning If model doesn't inherit from (or is of) @a type does nothing and
* returns #EINA_FALSE.
*
* @see eina_model_child_criteria_match()
* @see _Eina_Model_Type
@ -1888,8 +1886,8 @@ EAPI int eina_model_type_child_criteria_match(const Eina_Model_Type *type,
* @param model The model instance.
* @param compare Function used to compare children.
*
* @warning If model doesn't inherit from(or is of) @a type does nothing and
* returns EINA_FALSE.
* @warning If model doesn't inherit from (or is of) @a type does nothing and
* returns #EINA_FALSE.
*
* @see eina_model_child_sort()
* @see _Eina_Model_Type
@ -1906,8 +1904,8 @@ EAPI void eina_model_type_child_sort(const Eina_Model_Type *type,
* @param count The number of children included in the iterator.
* @return Newly created iterator instance on success or @c NULL on failure.
*
* @warning If model doesn't inherit from(or is of) @a type does nothing and
* returns EINA_FALSE.
* @warning If model doesn't inherit from (or is of) @a type does nothing and
* returns #EINA_FALSE.
*
* @see eina_model_child_iterator_get()
* @see _Eina_Model_Type
@ -1925,8 +1923,8 @@ EAPI Eina_Iterator *eina_model_type_child_iterator_get(const Eina_Model_Type *ty
* @param count The number of children included in the iterator.
* @return Newly created iterator instance on success or @c NULL on failure.
*
* @warning If model doesn't inherit from(or is of) @a type does nothing and
* returns EINA_FALSE.
* @warning If model doesn't inherit from (or is of) @a type does nothing and
* returns #EINA_FALSE.
*
* @see eina_model_child_reversed_iterator_get()
* @see _Eina_Model_Type
@ -1945,8 +1943,8 @@ EAPI Eina_Iterator *eina_model_type_child_reversed_iterator_get(const Eina_Model
* @param compare Function used to compare children.
* @return Newly created iterator instance on success or @c NULL on failure.
*
* @warning If model doesn't inherit from(or is of) @a type does nothing and
* returns EINA_FALSE.
* @warning If model doesn't inherit from (or is of) @a type does nothing and
* returns #EINA_FALSE.
*
* @see eina_model_child_sorted_iterator_get()
* @see _Eina_Model_Type
@ -1967,8 +1965,8 @@ EAPI Eina_Iterator *eina_model_type_child_sorted_iterator_get(const Eina_Model_T
* @param data Data given to the @a match function. May be NULL.
* @return Newly created iterator instance on success or @c NULL on failure.
*
* @warning If model doesn't inherit from(or is of) @a type does nothing and
* returns EINA_FALSE.
* @warning If model doesn't inherit from (or is of) @a type does nothing and
* returns #EINA_FALSE.
*
* @see eina_model_child_filtered_iterator_get()
* @see _Eina_Model_Type
@ -1986,8 +1984,8 @@ EAPI Eina_Iterator *eina_model_type_child_filtered_iterator_get(const Eina_Model
* @param model The model instance.
* @return String representationof @a model.
*
* @warning If model doesn't inherit from(or is of) @a type does nothing and
* returns EINA_FALSE.
* @warning If model doesn't inherit from (or is of) @a type does nothing and
* returns #EINA_FALSE.
*
* @see eina_model_to_string()
* @see _Eina_Model_Type
@ -2109,9 +2107,9 @@ EAPI const void *eina_model_type_method_offset_resolve(const Eina_Model_Type *ty
* type counterparts. Unlike setup and flush, they are not
* guaranteed to be called.
* @note use the same name pointer on queries to speed up the lookups!
* @note a runtime check will enforce just types with ABI version
* #EINA_MODEL_INTERFACE_VERSION are used by comparing with the
* @c version member.
* @note a runtime check will enforce just types with ABI
* version #EINA_MODEL_INTERFACE_VERSION are used by comparing
* with the @c version member.
*
* @since 1.2
*/
@ -2214,8 +2212,8 @@ struct _Eina_Model_Interface
* @param model The model instance.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If @a model doesn't implement @a iface does nothing and returns
* EINA_FALSE.
* @warning If @a model doesn't implement @a iface does nothing and
* returns #EINA_FALSE.
*
* @see eina_model_new()
* @see _Eina_Model_Interface
@ -2229,8 +2227,8 @@ EAPI Eina_Bool eina_model_interface_constructor(const Eina_Model_Interface *ifac
* @param model The model instance.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If @a model doesn't implement @a iface does nothing and returns
* EINA_FALSE.
* @warning If @a model doesn't implement @a iface does nothing and
* returns #EINA_FALSE.
*
* @see eina_model_del()
* @see _Eina_Model_Interface
@ -2245,8 +2243,8 @@ EAPI Eina_Bool eina_model_interface_destructor(const Eina_Model_Interface *iface
* @param dst Pointer to where copy will be put.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If @a model doesn't implement @a iface does nothing and returns
* EINA_FALSE.
* @warning If @a model doesn't implement @a iface does nothing and
* returns #EINA_FALSE.
*
* @see eina_model_copy()
* @see _Eina_Model_Interface
@ -2262,8 +2260,8 @@ EAPI Eina_Bool eina_model_interface_copy(const Eina_Model_Interface *iface,
* @param dst Pointer to where copy will be put.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If @a model doesn't implement @a iface does nothing and returns
* EINA_FALSE.
* @warning If @a model doesn't implement @a iface does nothing and
* returns #EINA_FALSE.
*
* @see eina_model_deep_copy()
* @see _Eina_Model_Interface
@ -2472,8 +2470,8 @@ EAPI void *eina_model_interface_private_data_get(const Eina_Model *model,
* @typedef Eina_Model_Interface_Properties
* Interface to manage model's properties.
*
* This extends #Eina_Model_Interface as expected by interface name
* #EINA_MODEL_INTERFACE_NAME_PROPERTIES.
* This extends #Eina_Model_Interface as expected by interface
* name #EINA_MODEL_INTERFACE_NAME_PROPERTIES.
*
* This interface is meant to help managing properties of a model, it
* is used by #EINA_MODEL_TYPE_MIXIN in order to configure methods for
@ -2488,8 +2486,8 @@ typedef struct _Eina_Model_Interface_Properties Eina_Model_Interface_Properties;
* @struct _Eina_Model_Interface_Properties
* Interface to manage model's properties.
*
* This extends #Eina_Model_Interface as expected by interface name
* #EINA_MODEL_INTERFACE_NAME_PROPERTIES.
* This extends #Eina_Model_Interface as expected by interface
* name #EINA_MODEL_INTERFACE_NAME_PROPERTIES.
*
* This interface is meant to help managing properties of a model, it
* is used by #EINA_MODEL_TYPE_MIXIN in order to configure methods for
@ -2521,7 +2519,7 @@ struct _Eina_Model_Interface_Properties
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If either model doesn't implement @a iface will do nothing and
* return EINA_FALSE.
* return #EINA_FALSE.
*
* @see eina_model_compare()
* @since 1.2
@ -2538,7 +2536,7 @@ EAPI Eina_Bool eina_model_interface_properties_compare(const Eina_Model_Interfac
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If either model doesn't implement @a iface will do nothing and
* return EINA_FALSE.
* return #EINA_FALSE.
*
* @see eina_model_load()
* @since 1.2
@ -2552,7 +2550,7 @@ EAPI Eina_Bool eina_model_interface_properties_load(const Eina_Model_Interface *
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If either model doesn't implement @a iface will do nothing and
* return EINA_FALSE.
* return #EINA_FALSE.
*
* @see eina_model_unload()
* @since 1.2
@ -2568,7 +2566,7 @@ EAPI Eina_Bool eina_model_interface_properties_unload(const Eina_Model_Interface
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If either model doesn't implement @a iface will do nothing and
* return EINA_FALSE.
* return #EINA_FALSE.
*
* @see eina_model_property_get()
* @since 1.2
@ -2586,7 +2584,7 @@ EAPI Eina_Bool eina_model_interface_properties_get(const Eina_Model_Interface *i
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If either model doesn't implement @a iface will do nothing and
* return EINA_FALSE.
* return #EINA_FALSE.
*
* @see eina_model_property_set()
* @since 1.2
@ -2603,7 +2601,7 @@ EAPI Eina_Bool eina_model_interface_properties_set(const Eina_Model_Interface *i
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If either model doesn't implement @a iface will do nothing and
* return EINA_FALSE.
* return #EINA_FALSE.
*
* @see eina_model_property_del()
* @since 1.2
@ -2620,7 +2618,7 @@ EAPI Eina_Bool eina_model_interface_properties_del(const Eina_Model_Interface *i
* @return #Eina_List of properties' names.
*
* @warning If either model doesn't implement @a iface will do nothing and
* return EINA_FALSE.
* return #EINA_FALSE.
*
* @see eina_model_properties_names_list_get()
* @since 1.2
@ -2632,8 +2630,8 @@ EAPI Eina_List *eina_model_interface_properties_names_list_get(const Eina_Model_
* @typedef Eina_Model_Interface_Children
* Interface to manage model's children.
*
* This extends #Eina_Model_Interface as expected by interface name
* #EINA_MODEL_INTERFACE_NAME_CHILDREN.
* This extends #Eina_Model_Interface as expected by interface
* name #EINA_MODEL_INTERFACE_NAME_CHILDREN.
*
* This interface is meant to help managing properties of a model, it
* is used by #EINA_MODEL_TYPE_MIXIN in order to configure methods for
@ -2654,8 +2652,8 @@ typedef struct _Eina_Model_Interface_Children Eina_Model_Interface_Children;
* @struct _Eina_Model_Interface_Children
* Interface to manage model's children.
*
* This extends #Eina_Model_Interface as expected by interface name
* #EINA_MODEL_INTERFACE_NAME_CHILDREN.
* This extends #Eina_Model_Interface as expected by interface
* name #EINA_MODEL_INTERFACE_NAME_CHILDREN.
*
* This interface is meant to help managing properties of a model, it
* is used by #EINA_MODEL_TYPE_MIXIN in order to configure methods for
@ -2689,7 +2687,7 @@ struct _Eina_Model_Interface_Children
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If either model doesn't implement @a iface will do nothing and
* return EINA_FALSE.
* return #EINA_FALSE.
*
* @see eina_model_compare()
* @since 1.2
@ -2705,7 +2703,7 @@ EAPI Eina_Bool eina_model_interface_children_compare(const Eina_Model_Interface
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If either model doesn't implement @a iface will do nothing and
* return EINA_FALSE.
* return #EINA_FALSE.
*
* @see eina_model_load()
* @since 1.2
@ -2719,7 +2717,7 @@ EAPI Eina_Bool eina_model_interface_children_load(const Eina_Model_Interface *if
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If either model doesn't implement @a iface will do nothing and
* return EINA_FALSE.
* return #EINA_FALSE.
*
* @see eina_model_unload()
* @since 1.2
@ -2733,7 +2731,7 @@ EAPI Eina_Bool eina_model_interface_children_unload(const Eina_Model_Interface *
* @return Number of children in @a model.
*
* @warning If either model doesn't implement @a iface will do nothing and
* return -1.
* return @c -1.
*
* @see eina_model_child_count()
* @since 1.2
@ -2748,7 +2746,7 @@ EAPI int eina_model_interface_children_count(const Eina_Model_Interface *iface,
* @return The requested child.
*
* @warning If either model doesn't implement @a iface will do nothing and
* return -1.
* return @c -1.
*
* @see eina_model_child_get()
* @since 1.2
@ -2765,7 +2763,7 @@ EAPI Eina_Model *eina_model_interface_children_get(const Eina_Model_Interface *i
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If either model doesn't implement @a iface will do nothing and
* return -1.
* return @c -1.
*
* @see eina_model_child_set()
* @since 1.2
@ -2782,7 +2780,7 @@ EAPI Eina_Bool eina_model_interface_children_set(const Eina_Model_Interface *ifa
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If either model doesn't implement @a iface will do nothing and
* return -1.
* return @c -1.
*
* @see eina_model_child_del()
* @since 1.2
@ -2799,7 +2797,7 @@ EAPI Eina_Bool eina_model_interface_children_del(const Eina_Model_Interface *ifa
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* @warning If either model doesn't implement @a iface will do nothing and
* return -1.
* return @c -1.
*
* @see eina_model_child_insert_at()
* @since 1.2
@ -2986,8 +2984,8 @@ EAPI extern const Eina_Model_Type *EINA_MODEL_TYPE_BASE;
/**
* @var EINA_MODEL_TYPE_MIXIN
*
* Type that uses #EINA_MODEL_INTERFACE_NAME_PROPERTIES and
* #EINA_MODEL_INTERFACE_NAME_CHILDREN to manage the model.
* Type that uses #EINA_MODEL_INTERFACE_NAME_PROPERTIES
* and #EINA_MODEL_INTERFACE_NAME_CHILDREN to manage the model.
*
* This is an abstract type, it does not work out of the box as one
* needs to subclass it and define the interface implementations for
@ -3002,9 +3000,9 @@ EAPI extern const Eina_Model_Type *EINA_MODEL_TYPE_MIXIN;
/**
* @var EINA_MODEL_TYPE_GENERIC
*
* Subclass of #EINA_MODEL_TYPE_MIXIN that uses
* #EINA_MODEL_INTERFACE_PROPERTIES_HASH and
* #EINA_MODEL_INTERFACE_CHILDREN_INARRAY.
* Subclass of #EINA_MODEL_TYPE_MIXIN that
* uses #EINA_MODEL_INTERFACE_PROPERTIES_HASH
* and #EINA_MODEL_INTERFACE_CHILDREN_INARRAY.
*
* Should be generic enough to hold lots of items with runtime
* configurable properties of any type.
@ -3018,9 +3016,9 @@ EAPI extern const Eina_Model_Type *EINA_MODEL_TYPE_GENERIC;
/**
* @var EINA_MODEL_TYPE_STRUCT
*
* Subclass of #EINA_MODEL_TYPE_MIXIN that uses
* #EINA_MODEL_INTERFACE_PROPERTIES_STRUCT and
* #EINA_MODEL_INTERFACE_CHILDREN_INARRAY.
* Subclass of #EINA_MODEL_TYPE_MIXIN that
* uses #EINA_MODEL_INTERFACE_PROPERTIES_STRUCT
* and #EINA_MODEL_INTERFACE_CHILDREN_INARRAY.
*
* Should be struct enough to hold lots of items with compile time
* configurable properties of any type.
@ -3093,8 +3091,8 @@ EAPI Eina_Bool eina_model_struct_get(const Eina_Model *model,
/**
* @var EINA_MODEL_INTERFACE_NAME_PROPERTIES
*
* Interface that uses #Eina_Model_Interface_Properties as
* #Eina_Model_Interface and can manage the model properties.
* Interface that uses #Eina_Model_Interface_Properties
* as #Eina_Model_Interface and can manage the model properties.
*
* @since 1.2
*/
@ -3122,8 +3120,8 @@ EAPI extern const Eina_Model_Interface *EINA_MODEL_INTERFACE_PROPERTIES_HASH;
* Implements #Eina_Model_Interface_Properties
* (#EINA_MODEL_INTERFACE_NAME_PROPERTIES) using #Eina_Value_Struct.
*
* The interface private data is #Eina_Value of type
* #EINA_VALUE_TYPE_STRUCT. Properties will be accessed using
* The interface private data is #Eina_Value of
* type #EINA_VALUE_TYPE_STRUCT. Properties will be accessed using
* Eina_Value_Struct::desc information that can be set by types such
* as #EINA_MODEL_TYPE_STRUCT
*
@ -3136,8 +3134,8 @@ EAPI extern const Eina_Model_Interface *EINA_MODEL_INTERFACE_PROPERTIES_STRUCT;
/**
* @var EINA_MODEL_INTERFACE_NAME_CHILDREN
*
* Interface that uses #Eina_Model_Interface_Children as
* #Eina_Model_Interface and can manage the model children.
* Interface that uses #Eina_Model_Interface_Children
* as #Eina_Model_Interface and can manage the model children.
*
* @since 1.2
*/

14
legacy/eina/src/include/eina_module.h
View File

@ -101,8 +101,7 @@ typedef void (*Eina_Module_Shutdown)(void);
/**
* @def EINA_MODULE_SHUTDOWN
* declares the given function as the module shutdownializer
* (__eina_module_shutdown). It must be of signature
* #Eina_Module_Shutdown
* (__eina_module_shutdown). It must be of signature #Eina_Module_Shutdown
*/
#define EINA_MODULE_SHUTDOWN(f) EAPI Eina_Module_Shutdown __eina_module_shutdown = &f
@ -159,12 +158,11 @@ EAPI Eina_Bool
* eina_module_new(). If it is a internal Eina module (like the
* mempools), it also initialize it. It the shared file object can not
* be loaded, the error #EINA_ERROR_WRONG_MODULE is set and
* #EINA_FALSE is returned. If it is a internal Eina module and the
* module can not be initialized, the error
* #EINA_ERROR_MODULE_INIT_FAILED is set and #EINA_FALSE is
* returned. If the module has already been loaded, it's reference
* counter is increased by one and #EINA_TRUE is returned. If @p module is
* @c NULL, the function returns immediately #EINA_FALSE.
* and #EINA_FALSE is returned. If it is a internal Eina module and the
* module can not be initialized, the error #EINA_ERROR_MODULE_INIT_FAILED
* is set and #EINA_FALSE is returned. If the module has already been loaded,
* it's reference counter is increased by one and #EINA_TRUE is returned.
* If @p module is @c NULL, the function returns immediately #EINA_FALSE.
*
* When the symbols of the shared file objects are not needed
* anymore, call eina_module_unload() to unload the module.

12
legacy/eina/src/include/eina_rbtree.h
View File

@ -202,8 +202,8 @@ static inline Eina_Rbtree *eina_rbtree_inline_lookup(const Eina_Rbtree *root, co
* NULL, this function still returns a valid iterator that will always
* return false on eina_iterator_next(), thus keeping API sane.
*
* If the memory can not be allocated, NULL is returned and
* #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
* If the memory can not be allocated, @c NULL is returned
* and #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
* returned.
*
* @warning if the rbtree structure changes then the iterator becomes
@ -223,8 +223,8 @@ EAPI Eina_Iterator *eina_rbtree_iterator_prefix(const Eina_Rbtree *root)
* NULL, this function still returns a valid iterator that will always
* return false on eina_iterator_next(), thus keeping API sane.
*
* If the memory can not be allocated, NULL is returned and
* #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
* If the memory can not be allocated, @c NULL is returned
* and #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
* returned.
*
* @warning if the rbtree structure changes then the iterator becomes
@ -244,8 +244,8 @@ EAPI Eina_Iterator *eina_rbtree_iterator_infix(const Eina_Rbtree *root) E
* NULL, this function still returns a valid iterator that will always
* return false on eina_iterator_next(), thus keeping API sane.
*
* If the memory can not be allocated, NULL is returned and
* #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
* If the memory can not be allocated, @c NULL is returned
* and #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
* returned.
*
* @warning if the rbtree structure changes then the iterator becomes

28
legacy/eina/src/include/eina_strbuf.h
View File

@ -146,8 +146,8 @@ EAPI void eina_strbuf_reset(Eina_Strbuf *buf) EINA_ARG_NONNULL(1);
* This function appends @p str to @p buf. It computes the length of
* @p str, so is slightly slower than eina_strbuf_append_length(). If
* the length is known beforehand, consider using that variant. If
* @p buf can't append it, #EINA_FALSE is returned, otherwise
* #EINA_TRUE is returned.
* @p buf can't append it, #EINA_FALSE is returned, otherwise #EINA_TRUE is
* returned.
*
* @see eina_strbuf_append()
* @see eina_strbuf_append_length()
@ -219,8 +219,8 @@ EAPI Eina_Bool eina_strbuf_append_length(Eina_Strbuf *buf, const char *str, size
* @param c The char to append.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* This function inserts @p c to @p buf. If it can not insert it,
* #EINA_FALSE is returned, otherwise #EINA_TRUE is returned.
* This function inserts @p c to @p buf. If it can not insert it, #EINA_FALSE
* is returned, otherwise #EINA_TRUE is returned.
*/
EAPI Eina_Bool eina_strbuf_append_char(Eina_Strbuf *buf, char c) EINA_ARG_NONNULL(1);
@ -349,8 +349,8 @@ EAPI Eina_Bool eina_strbuf_insert_char(Eina_Strbuf *buf, char c, size_t pos) EIN
*
* This function insert a string as described by the format @p fmt to @p buf at
* the position @p pos. @p fmt must be of a valid format for printf family of
* functions. If it can't insert it, #EINA_FALSE is returned, otherwise
* #EINA_TRUE is returned.
* functions. If it can't insert it, #EINA_FALSE is returned,
* otherwise #EINA_TRUE is returned.
*/
EAPI Eina_Bool eina_strbuf_insert_printf(Eina_Strbuf *buf, const char *fmt, size_t pos, ...) EINA_ARG_NONNULL(1, 2) EINA_PRINTF(2, 4);
@ -390,8 +390,8 @@ EAPI Eina_Bool eina_strbuf_insert_vprintf(Eina_Strbuf *buf, const char *fmt, siz
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* This macro is calling eina_strbuf_insert_escaped() at position 0. If
* @p buf can't prepend it, #EINA_FALSE is returned, otherwise
* #EINA_TRUE is returned.
* @p buf can't prepend it, #EINA_FALSE is returned, otherwise #EINA_TRUE is
* returned.
*/
#define eina_strbuf_prepend_escaped(buf, str) eina_strbuf_insert_escaped(buf, str, 0)
@ -405,8 +405,8 @@ EAPI Eina_Bool eina_strbuf_insert_vprintf(Eina_Strbuf *buf, const char *fmt, siz
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* This macro is calling eina_strbuf_insert_n() at position 0. If
* @p buf can't prepend it, #EINA_FALSE is returned, otherwise
* #EINA_TRUE is returned.
* @p buf can't prepend it, #EINA_FALSE is returned, otherwise #EINA_TRUE is
* returned.
*/
#define eina_strbuf_prepend_n(buf, str, maxlen) eina_strbuf_insert_n(buf, str, maxlen, 0)
@ -420,8 +420,8 @@ EAPI Eina_Bool eina_strbuf_insert_vprintf(Eina_Strbuf *buf, const char *fmt, siz
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* This macro is calling eina_strbuf_insert_length() at position 0. If
* @p buf can't prepend it, #EINA_FALSE is returned, otherwise
* #EINA_TRUE is returned.
* @p buf can't prepend it, #EINA_FALSE is returned, otherwise #EINA_TRUE is
* returned.
*/
#define eina_strbuf_prepend_length(buf, str, length) eina_strbuf_insert_length(buf, str, length, 0)
@ -434,8 +434,8 @@ EAPI Eina_Bool eina_strbuf_insert_vprintf(Eina_Strbuf *buf, const char *fmt, siz
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* This macro is calling eina_strbuf_insert_char() at position 0. If
* @p buf can't prepend it, #EINA_FALSE is returned, otherwise
* #EINA_TRUE is returned.
* @p buf can't prepend it, #EINA_FALSE is returned, otherwise #EINA_TRUE
* is returned.
*/
#define eina_strbuf_prepend_char(buf, c) eina_strbuf_insert_char(buf, c, 0)

3
legacy/eina/src/include/eina_tiler.h
View File

@ -254,8 +254,7 @@ EAPI Eina_Iterator *eina_tiler_iterator_new(const Eina_Tiler *t);
*
* The region defined by @a x, @a y, @a w, @a h will be divided in to a grid of
* tiles of width @a tile_w and height @p tile_h, the returned iterator will
* iterate over every tile in the grid having as its data a
* #Eina_Tile_Grid_Info.
* iterate over every tile in the grid having as its data a #Eina_Tile_Grid_Info.
*
* @note This is a convenience function, iterating over the returned iterator is
* equivalent to calling eina_tile_grid_slicer_setup() and calling

28
legacy/eina/src/include/eina_ustrbuf.h
View File

@ -115,8 +115,8 @@ EAPI void eina_ustrbuf_reset(Eina_UStrbuf *buf) EINA_ARG_NONNULL(1);
* This function appends @p str to @p buf. It computes the length of
* @p str, so is slightly slower than eina_ustrbuf_append_length(). If
* the length is known beforehand, consider using that variant. If
* @p buf can't append it, #EINA_FALSE is returned, otherwise
* #EINA_TRUE is returned.
* @p buf can't append it, #EINA_FALSE is returned, otherwise #EINA_TRUE is
* returned.
*
* @see eina_ustrbuf_append()
* @see eina_ustrbuf_append_length()
@ -131,8 +131,8 @@ EAPI Eina_Bool eina_ustrbuf_append(Eina_UStrbuf *buf, const Eina_Unicode *str) E
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* This function appends the escaped string @p str to @p buf. If @p
* str can not be appended, #EINA_FALSE is returned, otherwise,
* #EINA_TRUE is returned.
* str can not be appended, #EINA_FALSE is returned, otherwise, #EINA_TRUE is
* returned.
*/
EAPI Eina_Bool eina_ustrbuf_append_escaped(Eina_UStrbuf *buf, const Eina_Unicode *str) EINA_ARG_NONNULL(1, 2);
@ -188,8 +188,8 @@ EAPI Eina_Bool eina_ustrbuf_append_length(Eina_UStrbuf *buf, const Eina_Unicode
* @param c The char to append.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* This function inserts @p c to @p buf. If it can not insert it,
* #EINA_FALSE is returned, otherwise #EINA_TRUE is returned.
* This function inserts @p c to @p buf. If it can not insert it, #EINA_FALSE
* is returned, otherwise #EINA_TRUE is returned.
*/
EAPI Eina_Bool eina_ustrbuf_append_char(Eina_UStrbuf *buf, Eina_Unicode c) EINA_ARG_NONNULL(1);
@ -304,8 +304,8 @@ EAPI Eina_Bool eina_ustrbuf_insert_char(Eina_UStrbuf *buf, Eina_Unicode c, size_
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* This macro is calling eina_ustrbuf_insert_escaped() at position 0. If
* @p buf can't prepend it, #EINA_FALSE is returned, otherwise
* #EINA_TRUE is returned.
* @p buf can't prepend it, #EINA_FALSE is returned, otherwise #EINA_TRUE is
* returned.
*/
#define eina_ustrbuf_prepend_escaped(buf, str) eina_ustrbuf_insert_escaped(buf, str, 0)
@ -319,8 +319,8 @@ EAPI Eina_Bool eina_ustrbuf_insert_char(Eina_UStrbuf *buf, Eina_Unicode c, size_
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* This macro is calling eina_ustrbuf_insert_n() at position 0. If
* @p buf can't prepend it, #EINA_FALSE is returned, otherwise
* #EINA_TRUE is returned.
* @p buf can't prepend it, #EINA_FALSE is returned, otherwise #EINA_TRUE is
* returned.
*/
#define eina_ustrbuf_prepend_n(buf, str, maxlen) eina_ustrbuf_insert_n(buf, str, maxlen, 0)
@ -334,8 +334,8 @@ EAPI Eina_Bool eina_ustrbuf_insert_char(Eina_UStrbuf *buf, Eina_Unicode c, size_
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* This macro is calling eina_ustrbuf_insert_length() at position 0. If
* @p buf can't prepend it, #EINA_FALSE is returned, otherwise
* #EINA_TRUE is returned.
* @p buf can't prepend it, #EINA_FALSE is returned, otherwise #EINA_TRUE is
* returned.
*/
#define eina_ustrbuf_prepend_length(buf, str, length) eina_ustrbuf_insert_length(buf, str, length, 0)
@ -348,8 +348,8 @@ EAPI Eina_Bool eina_ustrbuf_insert_char(Eina_UStrbuf *buf, Eina_Unicode c, size_
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* This macro is calling eina_ustrbuf_insert_Eina_Unicode *() at position 0. If
* @p buf can't prepend it, #EINA_FALSE is returned, otherwise
* #EINA_TRUE is returned.
* @p buf can't prepend it, #EINA_FALSE is returned, otherwise #EINA_TRUE is
* returned.
*/
#define eina_ustrbuf_prepend_char(buf, c) eina_ustrbuf_insert_char(buf, c, 0)

89
legacy/eina/src/include/eina_value.h
View File

@ -476,8 +476,8 @@ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_STRING;
* pointer to an #Eina_Value_Array. For your convenience, use
* eina_value_array_setup().
*
* eina_value_get() and eina_value_pget() takes a pointer to
* #Eina_Value_Array, it's an exact copy of the current structure in
* eina_value_get() and eina_value_pget() takes a pointer
* to #Eina_Value_Array, it's an exact copy of the current structure in
* use by value, no copies are done.
*
* @since 1.2
@ -495,13 +495,12 @@ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_ARRAY;
* eina_value_set() takes an #Eina_Value_List where just @c subtype is
* used. If there is an @c list, it will be copied (including each
* item) and its contents must be properly configurable as @c
* subtype expects. eina_value_pset() takes a pointer to an
* #Eina_Value_List. For your convenience, use
* eina_value_list_setup().
* subtype expects. eina_value_pset() takes a pointer to an #Eina_Value_List.
* For your convenience, use eina_value_list_setup().
*
* eina_value_get() and eina_value_pget() takes a pointer to
* #Eina_Value_List, it's an exact copy of the current structure in
* use by value, no copies are done.
* eina_value_get() and eina_value_pget() takes a pointer to #Eina_Value_List,
* it's an exact copy of the current structure in use by value, no copies are
* done.
*
* @since 1.2
*/
@ -522,9 +521,9 @@ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_LIST;
* takes a pointer to an #Eina_Value_Hash. For your convenience, use
* eina_value_hash_setup().
*
* eina_value_get() and eina_value_pget() takes a pointer to
* #Eina_Value_Hash, it's an exact copy of the current structure in
* use by value, no copies are done.
* eina_value_get() and eina_value_pget() takes a pointer to #Eina_Value_Hash,
* it's an exact copy of the current structure in use by value, no copies are
* done.
*
* @note be aware that hash data is always an allocated memory of size
* defined by @c subtype->value_size. If your @c subtype is an
@ -557,9 +556,8 @@ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_TIMEVAL;
* eina_value_set() takes an #Eina_Value_Blob
* eina_value_pset() takes a pointer to #Eina_Value_Blob.
*
* eina_value_get() and eina_value_pget() takes a pointer to
* #Eina_Value_Blob and it's an exact copy of value, no allocations
* are made.
* eina_value_get() and eina_value_pget() takes a pointer to #Eina_Value_Blob
* and it's an exact copy of value, no allocations are made.
*
* Memory is untouched unless you provide @c ops (operations) pointer.
*
@ -578,12 +576,11 @@ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_BLOB;
* eina_value_set() takes an #Eina_Value_Struct where just @c desc is
* used. If there is an @c memory, it will be copied (including each
* member) and its contents must be properly configurable as @c desc
* expects. eina_value_pset() takes a pointer to an
* #Eina_Value_Struct. For your convenience, use
* eina_value_struct_setup().
* expects. eina_value_pset() takes a pointer to an #Eina_Value_Struct. For
* your convenience, use eina_value_struct_setup().
*
* eina_value_get() and eina_value_pget() takes a pointer to
* #Eina_Value_Struct, it's an exact copy of the current structure in
* eina_value_get() and eina_value_pget() takes a pointer
* to #Eina_Value_Struct, it's an exact copy of the current structure in
* use by value, no copies are done.
*
* @since 1.2
@ -628,8 +625,8 @@ struct _Eina_Value
* eg. #EINA_VALUE_TYPE_ARRAY uses eina_value_array_set(),
* eina_value_array_get() and so on.
*
* On failure, @c NULL is returned and either #EINA_ERROR_OUT_OF_MEMORY or
* #EINA_ERROR_VALUE_FAILED is set.
* On failure, @c NULL is returned and either #EINA_ERROR_OUT_OF_MEMORY
* or #EINA_ERROR_VALUE_FAILED is set.
*
* @note this calls creates from mempool and then uses
* eina_value_setup(). Consider using eina_value_flush() and
@ -661,9 +658,8 @@ EAPI void eina_value_free(Eina_Value *value) EINA_ARG_NONNULL(1);
* Initializes existing generic value storage. The members are managed using the
* description specified by @a type.
*
* Some types may specify more operations, as an example
* #EINA_VALUE_TYPE_ARRAY uses eina_value_array_set(),
* eina_value_array_get() and so on.
* Some types may specify more operations, as an example #EINA_VALUE_TYPE_ARRAY
* uses eina_value_array_set(), eina_value_array_get() and so on.
*
* @note Existing contents are ignored! If the value was previously used, then
* use eina_value_flush() first.
@ -1107,8 +1103,8 @@ struct _Eina_Value_Array
* Create a new generic value storage of type array. The members are
* managed using the description specified by @a subtype.
*
* On failure, @c NULL is returned and #EINA_ERROR_OUT_OF_MEMORY or
* #EINA_ERROR_VALUE_FAILED is set.
* On failure, @c NULL is returned and #EINA_ERROR_OUT_OF_MEMORY
* or #EINA_ERROR_VALUE_FAILED is set.
*
* @note this creates from mempool and then uses
* eina_value_array_setup(). @see eina_value_free() @see
@ -1129,9 +1125,9 @@ EAPI Eina_Value *eina_value_array_new(const Eina_Value_Type *subtype,
* Initializes new generic value storage of type array with the given
* @a subtype.
*
* This is the same as calling eina_value_set() with
* #EINA_VALUE_TYPE_ARRAY followed by eina_value_pset() with the
* #Eina_Value_Array description configured.
* This is the same as calling eina_value_set()
* with #EINA_VALUE_TYPE_ARRAY followed by eina_value_pset() with
* the #Eina_Value_Array description configured.
*
* @note Existing contents are ignored! If the value was previously used, then
* use eina_value_flush() first.
@ -1757,8 +1753,8 @@ struct _Eina_Value_List
* Create a new generic value storage of type list. The members are
* managed using the description specified by @a subtype.
*
* On failure, @c NULL is returned and #EINA_ERROR_OUT_OF_MEMORY or
* #EINA_ERROR_VALUE_FAILED is set.
* On failure, @c NULL is returned and #EINA_ERROR_OUT_OF_MEMORY
* or #EINA_ERROR_VALUE_FAILED is set.
*
* @note this creates from mempool and then uses
* eina_value_list_setup().
@ -1779,9 +1775,9 @@ EAPI Eina_Value *eina_value_list_new(const Eina_Value_Type *subtype) EINA_ARG_NO
* Initializes new generic value storage of type list with the given
* @a subtype.
*
* This is the same as calling eina_value_set() with
* #EINA_VALUE_TYPE_LIST followed by eina_value_pset() with the
* #Eina_Value_List description configured.
* This is the same as calling eina_value_set()
* with #EINA_VALUE_TYPE_LIST followed by eina_value_pset() with
* the #Eina_Value_List description configured.
*
* @note Existing contents are ignored! If the value was previously used, then
* use eina_value_flush() first.
@ -2383,8 +2379,8 @@ struct _Eina_Value_Hash
* Create a new generic value storage of type hash. The members are
* managed using the description specified by @a subtype.
*
* On failure, @c NULL is returned and #EINA_ERROR_OUT_OF_MEMORY or
* #EINA_ERROR_VALUE_FAILED is set.
* On failure, @c NULL is returned and #EINA_ERROR_OUT_OF_MEMORY
* or #EINA_ERROR_VALUE_FAILED is set.
*
* @note this creates from mempool and then uses
* eina_value_hash_setup().
@ -2407,9 +2403,9 @@ EAPI Eina_Value *eina_value_hash_new(const Eina_Value_Type *subtype, unsigned in
* Initializes new generic value storage of type hash with the given
* @a subtype.
*
* This is the same as calling eina_value_set() with
* #EINA_VALUE_TYPE_HASH followed by eina_value_pset() with the
* #Eina_Value_Hash description configured.
* This is the same as calling eina_value_set()
* with #EINA_VALUE_TYPE_HASH followed by eina_value_pset() with
* the #Eina_Value_Hash description configured.
*
* @note Existing contents are ignored! If the value was previously used, then
* use eina_value_flush() first.
@ -2864,9 +2860,8 @@ EAPI extern const Eina_Value_Struct_Operations *EINA_VALUE_STRUCT_OPERATIONS_STR
* specified as _Eina_Value_Struct_Operations::find_member(). For
* structures with huge number of members, consider using a better
* find_member function to quickly finding it! There are two helper
* operations provided to help this:
* #EINA_VALUE_STRUCT_OPERATIONS_BINSEARCH and
* #EINA_VALUE_STRUCT_OPERATIONS_STRINGSHARE, both depend on properly
* operations provided to help this: #EINA_VALUE_STRUCT_OPERATIONS_BINSEARCH
* and #EINA_VALUE_STRUCT_OPERATIONS_STRINGSHARE, both depend on properly
* set #_Eina_Value_Struct_Desc and #_Eina_Value_Struct_Member.
*
* @see #EINA_VALUE_STRUCT_MEMBER
@ -2947,8 +2942,8 @@ struct _Eina_Value_Struct
* Create a new generic value storage of type struct. The members are
* managed using the description specified by @a desc.
*
* On failure, @c NULL is returned and #EINA_ERROR_OUT_OF_MEMORY or
* #EINA_ERROR_VALUE_FAILED is set.
* On failure, @c NULL is returned and #EINA_ERROR_OUT_OF_MEMORY
* or #EINA_ERROR_VALUE_FAILED is set.
*
* @note this creates from mempool and then uses
* eina_value_struct_setup().
@ -2969,9 +2964,9 @@ EAPI Eina_Value *eina_value_struct_new(const Eina_Value_Struct_Desc *desc) EINA_
* Initializes new generic value storage of type struct with the given
* @a desc.
*
* This is the same as calling eina_value_set() with
* #EINA_VALUE_TYPE_STRUCT followed by eina_value_pset() with the
* #Eina_Value_Struct description configured.
* This is the same as calling eina_value_set()
* with #EINA_VALUE_TYPE_STRUCT followed by eina_value_pset() with
* the #Eina_Value_Struct description configured.
*
* @note Existing contents are ignored! If the value was previously used, then
* use eina_value_flush() first.

5
legacy/eina/src/lib/eina_convert.c
View File

@ -113,9 +113,8 @@ static const char EINA_ERROR_CONVERT_OUTRUN_STRING_LENGTH_STR[] =
* eina_init().
*
* This function sets up the error module of Eina and registers the
* errors #EINA_ERROR_CONVERT_0X_NOT_FOUND,
* #EINA_ERROR_CONVERT_P_NOT_FOUND and
* #EINA_ERROR_CONVERT_OUTRUN_STRING_LENGTH.
* errors #EINA_ERROR_CONVERT_0X_NOT_FOUND, #EINA_ERROR_CONVERT_P_NOT_FOUND
* and #EINA_ERROR_CONVERT_OUTRUN_STRING_LENGTH.
*
* @see eina_init()
*/

3
legacy/eina/src/lib/eina_module.c
View File

@ -229,8 +229,7 @@ EAPI Eina_Error EINA_ERROR_MODULE_INIT_FAILED = 0;
* called by eina_init().
*
* This function sets up the module module of Eina. It also registers
* the errors #EINA_ERROR_WRONG_MODULE and
* #EINA_ERROR_MODULE_INIT_FAILED.
* the errors #EINA_ERROR_WRONG_MODULE and #EINA_ERROR_MODULE_INIT_FAILED.
*
* @see eina_init()
*/

8
legacy/eina/src/lib/eina_strbuf_common.c
View File

@ -352,8 +352,8 @@ eina_strbuf_common_reset(size_t csize, Eina_Strbuf *buf)
* This function appends @p str to @p buf. It computes the length of
* @p str, so is slightly slower than eina_strbuf_common_append_length(). If
* the length is known beforehand, consider using that variant. If
* @p buf can't append it, #EINA_FALSE is returned, otherwise
* #EINA_TRUE is returned.
* @p buf can't append it, #EINA_FALSE is returned, otherwise #EINA_TRUE is
* returned.
*
* @see eina_strbuf_common_append()
* @see eina_strbuf_common_append_length()
@ -565,8 +565,8 @@ eina_strbuf_common_insert_length(size_t csize,
* @param c The char to append.
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* This function inserts @p c to @p buf. If it can not insert it,
* #EINA_FALSE is returned, otherwise #EINA_TRUE is returned.
* This function inserts @p c to @p buf. If it can not insert it, #EINA_FALSE
* is returned, otherwise #EINA_TRUE is returned.
*/
Eina_Bool
eina_strbuf_common_append_char(size_t csize, Eina_Strbuf *buf, const void *c)