summaryrefslogtreecommitdiff
path: root/src/lib/eina
diff options
context:
space:
mode:
authorMyoungwoon Roy, Kim <myoungwoon.kim@samsung.com>2017-02-20 15:18:21 +0900
committerJean-Philippe Andre <jp.andre@samsung.com>2017-02-21 10:46:28 +0900
commitec71f6607a2d6dc84f22ecd962c4d862c0924d4d (patch)
tree92a3554d2010d06fa60be9ab8ddd0974d6b50a39 /src/lib/eina
parent2ea9e7010cb62d01342fa5379be881246ccf1f18 (diff)
docs: Fix typos and some wrong expressions in Eina API reference doxygen.
Summary: I had fixed some typos and some wrong expressions, such as capital letters, singular, and orders of groups in Eina API reference doxygen. Test Plan: Doxygen Revision Reviewers: stefan, cedric, raster, Jaehyun_Cho, jpeg Reviewed By: jpeg Subscribers: conr2d Differential Revision: https://phab.enlightenment.org/D4674
Diffstat (limited to 'src/lib/eina')
-rw-r--r--src/lib/eina/Eina.h2
-rw-r--r--src/lib/eina/eina_accessor.h51
-rw-r--r--src/lib/eina/eina_alloca.h2
-rw-r--r--src/lib/eina/eina_array.h38
-rw-r--r--src/lib/eina/eina_benchmark.h16
-rw-r--r--src/lib/eina/eina_bezier.h10
-rw-r--r--src/lib/eina/eina_binbuf.h60
-rw-r--r--src/lib/eina/eina_binshare.h14
-rw-r--r--src/lib/eina/eina_clist.h13
-rw-r--r--src/lib/eina/eina_convert.h56
-rw-r--r--src/lib/eina/eina_counter.h31
-rw-r--r--src/lib/eina/eina_cow.h22
-rw-r--r--src/lib/eina/eina_cpu.h18
-rw-r--r--src/lib/eina/eina_crc.h2
-rw-r--r--src/lib/eina/eina_error.h49
-rw-r--r--src/lib/eina/eina_evlog.h8
-rw-r--r--src/lib/eina/eina_file.h156
-rw-r--r--src/lib/eina/eina_fp.h72
-rw-r--r--src/lib/eina/eina_hamster.h2
-rw-r--r--src/lib/eina/eina_hash.h84
-rw-r--r--src/lib/eina/eina_inarray.h105
-rw-r--r--src/lib/eina/eina_inlist.h102
-rw-r--r--src/lib/eina/eina_iterator.h18
-rw-r--r--src/lib/eina/eina_lalloc.h14
-rw-r--r--src/lib/eina/eina_list.h112
-rw-r--r--src/lib/eina/eina_lock.h222
-rw-r--r--src/lib/eina/eina_log.h156
-rw-r--r--src/lib/eina/eina_magic.h40
-rw-r--r--src/lib/eina/eina_main.h24
-rw-r--r--src/lib/eina/eina_matrix.h104
-rw-r--r--src/lib/eina/eina_matrixsparse.h138
-rw-r--r--src/lib/eina/eina_mempool.h10
-rw-r--r--src/lib/eina/eina_mmap.h6
-rw-r--r--src/lib/eina/eina_module.h32
-rw-r--r--src/lib/eina/eina_prefix.h2
-rw-r--r--src/lib/eina/eina_quad.h2
-rw-r--r--src/lib/eina/eina_rbtree.h14
-rw-r--r--src/lib/eina/eina_rectangle.h68
-rw-r--r--src/lib/eina/eina_simple_xml_parser.h112
-rw-r--r--src/lib/eina/eina_str.h40
-rw-r--r--src/lib/eina/eina_strbuf.h128
-rw-r--r--src/lib/eina/eina_stringshare.h38
-rw-r--r--src/lib/eina/eina_thread.h34
-rw-r--r--src/lib/eina/eina_thread_queue.h30
-rw-r--r--src/lib/eina/eina_tiler.h36
-rw-r--r--src/lib/eina/eina_tmpstr.h24
-rw-r--r--src/lib/eina/eina_trash.h26
-rw-r--r--src/lib/eina/eina_types.h4
-rw-r--r--src/lib/eina/eina_unicode.h2
-rw-r--r--src/lib/eina/eina_ustrbuf.h78
-rw-r--r--src/lib/eina/eina_ustringshare.h26
-rw-r--r--src/lib/eina/eina_util.h8
-rw-r--r--src/lib/eina/eina_value.h470
-rw-r--r--src/lib/eina/eina_value_util.h4
-rw-r--r--src/lib/eina/eina_xattr.h40
55 files changed, 1440 insertions, 1535 deletions
diff --git a/src/lib/eina/Eina.h b/src/lib/eina/Eina.h
index 6a99b4fe68..41c182842b 100644
--- a/src/lib/eina/Eina.h
+++ b/src/lib/eina/Eina.h
@@ -197,9 +197,9 @@
197 * should return properly populated @ref _Eina_Iterator and @ref _Eina_Accessor. 197 * should return properly populated @ref _Eina_Iterator and @ref _Eina_Accessor.
198 * 198 *
199 * @defgroup Eina_Tools_Group Tools 199 * @defgroup Eina_Tools_Group Tools
200 * @ingroup Eina
200 * @brief Eina tools aims to help application development, providing ways to 201 * @brief Eina tools aims to help application development, providing ways to
201 * make it safer, log errors, manage memory more efficiently and more. 202 * make it safer, log errors, manage memory more efficiently and more.
202 * @ingroup Eina
203 */ 203 */
204 204
205#ifdef _WIN32 205#ifdef _WIN32
diff --git a/src/lib/eina/eina_accessor.h b/src/lib/eina/eina_accessor.h
index 38eff89b19..aed6d9d307 100644
--- a/src/lib/eina/eina_accessor.h
+++ b/src/lib/eina/eina_accessor.h
@@ -138,7 +138,7 @@ typedef Eina_Bool (*Eina_Accessor_Lock_Callback)(Eina_Accessor *it);
138 138
139/** 139/**
140 * @typedef Eina_Accessor_Clone_Callback 140 * @typedef Eina_Accessor_Clone_Callback
141 * @brief Type for a callback to return a clone for the accessor 141 * @brief Type for a callback to return a clone for the accessor.
142 * @since 1.10 142 * @since 1.10
143 */ 143 */
144typedef Eina_Accessor* (*Eina_Accessor_Clone_Callback)(Eina_Accessor *it); 144typedef Eina_Accessor* (*Eina_Accessor_Clone_Callback)(Eina_Accessor *it);
@@ -169,31 +169,31 @@ struct _Eina_Accessor
169 169
170/** 170/**
171 * @def FUNC_ACCESSOR_GET_AT(Function) 171 * @def FUNC_ACCESSOR_GET_AT(Function)
172 * @brief Helper macro to cast @a Function to a Eina_Accessor_Get_At_Callback. 172 * @brief Definition for helper macro to cast @a Function to a Eina_Accessor_Get_At_Callback.
173 */ 173 */
174#define FUNC_ACCESSOR_GET_AT(Function) ((Eina_Accessor_Get_At_Callback)Function) 174#define FUNC_ACCESSOR_GET_AT(Function) ((Eina_Accessor_Get_At_Callback)Function)
175 175
176/** 176/**
177 * @def FUNC_ACCESSOR_GET_CONTAINER(Function) 177 * @def FUNC_ACCESSOR_GET_CONTAINER(Function)
178 * @brief Helper macro to cast @a Function to a Eina_Accessor_Get_Container_Callback. 178 * @brief Definition for helper macro to cast @a Function to a Eina_Accessor_Get_Container_Callback.
179 */ 179 */
180#define FUNC_ACCESSOR_GET_CONTAINER(Function) ((Eina_Accessor_Get_Container_Callback)Function) 180#define FUNC_ACCESSOR_GET_CONTAINER(Function) ((Eina_Accessor_Get_Container_Callback)Function)
181 181
182/** 182/**
183 * @def FUNC_ACCESSOR_FREE(Function) 183 * @def FUNC_ACCESSOR_FREE(Function)
184 * @brief Helper macro to cast @a Function to a Eina_Accessor_Free_Callback. 184 * @brief Definition for helper macro to cast @a Function to a Eina_Accessor_Free_Callback.
185 */ 185 */
186#define FUNC_ACCESSOR_FREE(Function) ((Eina_Accessor_Free_Callback)Function) 186#define FUNC_ACCESSOR_FREE(Function) ((Eina_Accessor_Free_Callback)Function)
187 187
188/** 188/**
189 * @def FUNC_ACCESSOR_LOCK(Function) 189 * @def FUNC_ACCESSOR_LOCK(Function)
190 * @brief Helper macro to cast @a Function to a Eina_Iterator_Lock_Callback. 190 * @brief Definition for helper macro to cast @a Function to a Eina_Iterator_Lock_Callback.
191 */ 191 */
192#define FUNC_ACCESSOR_LOCK(Function) ((Eina_Accessor_Lock_Callback)Function) 192#define FUNC_ACCESSOR_LOCK(Function) ((Eina_Accessor_Lock_Callback)Function)
193 193
194/** 194/**
195 * @def FUNC_ACCESSOR_CLONE(Function) 195 * @def FUNC_ACCESSOR_CLONE(Function)
196 * @brief Helper macro to cast @p Function to a Eina_Iterator_Clone_Callback. 196 * @brief Definition for helper macro to cast @p Function to a Eina_Iterator_Clone_Callback.
197 * @since 1.10 197 * @since 1.10
198 */ 198 */
199#define FUNC_ACCESSOR_CLONE(Function) ((Eina_Accessor_Clone_Callback)Function) 199#define FUNC_ACCESSOR_CLONE(Function) ((Eina_Accessor_Clone_Callback)Function)
@@ -201,26 +201,23 @@ struct _Eina_Accessor
201 201
202/** 202/**
203 * @brief Frees an accessor. 203 * @brief Frees an accessor.
204 * 204 * @details This function frees @a accessor if it is not @c NULL.
205 * @param[in] accessor The accessor to free 205 * @param[in] accessor The accessor to free
206 * 206 *
207 * @details This function frees @a accessor if it is not @c NULL.
208 */ 207 */
209EAPI void eina_accessor_free(Eina_Accessor *accessor); 208EAPI void eina_accessor_free(Eina_Accessor *accessor);
210 209
211/** 210/**
212 * @brief Gets the data of an accessor at the given position. 211 * @brief Gets the data of an accessor at the given position.
213 * 212 * @details This function retrieves the data of the element pointed by
213 * @p accessor at the position @p position, and stores it in
214 * @p data. If @p accessor is @c NULL or if an error occurs, @c EINA_FALSE
215 * is returned, otherwise @c EINA_TRUE is returned.
214 * @param[in] accessor The accessor 216 * @param[in] accessor The accessor
215 * @param[in] position The position of the element 217 * @param[in] position The position of the element
216 * @param[in] data The pointer that stores the data to retrieve 218 * @param[in] data The pointer that stores the data to retrieve
217 * @return #EINA_TRUE on success, otherwise #EINA_FALSE 219 * @return #EINA_TRUE on success, otherwise #EINA_FALSE
218 * 220 *
219 * @details This function retrieves the data of the element pointed by
220 * @p accessor at the position @p position, and stores it in
221 * @p data. If @p accessor is @c NULL or if an error occurs, #EINA_FALSE
222 * is returned, otherwise #EINA_TRUE is returned.
223 *
224 */ 221 */
225EAPI Eina_Bool eina_accessor_data_get(Eina_Accessor *accessor, 222EAPI Eina_Bool eina_accessor_data_get(Eina_Accessor *accessor,
226 unsigned int position, 223 unsigned int position,
@@ -228,17 +225,22 @@ EAPI Eina_Bool eina_accessor_data_get(Eina_Accessor *accessor,
228 225
229/** 226/**
230 * @brief Gets the container of an accessor. 227 * @brief Gets the container of an accessor.
231 * 228 * @details This function returns the container that created @p accessor. If
229 * @p accessor is @c NULL, this function returns @c NULL.
232 * @param[in] accessor The accessor 230 * @param[in] accessor The accessor
233 * @return The container that created the accessor 231 * @return The container that created the accessor
234 * 232 *
235 * @details This function returns the container that created @p accessor. If
236 * @p accessor is @c NULL, this function returns @c NULL.
237 */ 233 */
238EAPI void *eina_accessor_container_get(Eina_Accessor *accessor) EINA_ARG_NONNULL(1) EINA_PURE; 234EAPI void *eina_accessor_container_get(Eina_Accessor *accessor) EINA_ARG_NONNULL(1) EINA_PURE;
239 235
240/** 236/**
241 * @brief Iterates over the container and executes a callback on the chosen elements. 237 * @brief Iterates over the container and executes a callback on the chosen elements.
238 * @details This function iterates over the elements pointed by @p accessor,
239 * starting from the element at position @p start and ending at the
240 * element at position @p end. For each element, the callback
241 * @p cb is called with the data @p fdata. If @p accessor is @c NULL
242 * or if @p start is greater than or equal to @p end, the function returns
243 * immediately.
242 * 244 *
243 * @param[in] accessor The accessor 245 * @param[in] accessor The accessor
244 * @param[in] cb The callback called on the chosen elements 246 * @param[in] cb The callback called on the chosen elements
@@ -246,12 +248,6 @@ EAPI void *eina_accessor_container_get(Eina_Accessor *accessor) EINA_ARG_NONNULL
246 * @param[in] end The position of the last element 248 * @param[in] end The position of the last element
247 * @param[in] fdata The data passed to the callback 249 * @param[in] fdata The data passed to the callback
248 * 250 *
249 * @details This function iterates over the elements pointed by @p accessor,
250 * starting from the element at position @p start and ending at the
251 * element at position @p end. For each element, the callback
252 * @p cb is called with the data @p fdata. If @p accessor is @c NULL
253 * or if @p start is greater than or equal to @p end, the function returns
254 * immediately.
255 */ 251 */
256EAPI void eina_accessor_over(Eina_Accessor *accessor, 252EAPI void eina_accessor_over(Eina_Accessor *accessor,
257 Eina_Each_Cb cb, 253 Eina_Each_Cb cb,
@@ -285,7 +281,7 @@ EAPI Eina_Bool eina_accessor_lock(Eina_Accessor *accessor) EINA_ARG_NONNULL(1);
285EAPI Eina_Accessor* eina_accessor_clone(Eina_Accessor *accessor) EINA_ARG_NONNULL(1); 281EAPI Eina_Accessor* eina_accessor_clone(Eina_Accessor *accessor) EINA_ARG_NONNULL(1);
286 282
287/** 283/**
288 * @brief Unlock the container of the accessor. 284 * @brief Unlocks the container of the accessor.
289 * 285 *
290 * @param[in] accessor The accessor 286 * @param[in] accessor The accessor
291 * @return #EINA_TRUE on success, otherwise #EINA_FALSE 287 * @return #EINA_TRUE on success, otherwise #EINA_FALSE
@@ -301,7 +297,9 @@ EAPI Eina_Bool eina_accessor_unlock(Eina_Accessor *accessor) EINA_ARG_NONNULL(1)
301 297
302/** 298/**
303 * @def EINA_ACCESSOR_FOREACH 299 * @def EINA_ACCESSOR_FOREACH
304 * @brief Helper macro to iterate over all the elements easily. 300 * @brief Definition for helper macro to iterate over all the elements easily.
301 * @details This macro allows a convenient way to loop over all elements in an
302 * accessor, very similar to EINA_LIST_FOREACH().
305 * 303 *
306 * @param accessor The accessor to use 304 * @param accessor The accessor to use
307 * @param counter A counter used by eina_accessor_data_get() when 305 * @param counter A counter used by eina_accessor_data_get() when
@@ -310,9 +308,6 @@ EAPI Eina_Bool eina_accessor_unlock(Eina_Accessor *accessor) EINA_ARG_NONNULL(1)
310 * It must be a pointer to support getting 308 * It must be a pointer to support getting
311 * its address since eina_accessor_data_get() requires a pointer. 309 * its address since eina_accessor_data_get() requires a pointer.
312 * 310 *
313 * @details This macro allows a convenient way to loop over all elements in an
314 * accessor, very similar to EINA_LIST_FOREACH().
315 *
316 * This macro can be used for freeing the data of a list, like in the 311 * This macro can be used for freeing the data of a list, like in the
317 * following example. It has the same goal as the one documented in 312 * following example. It has the same goal as the one documented in
318 * EINA_LIST_FOREACH(), but using accessors: 313 * EINA_LIST_FOREACH(), but using accessors:
diff --git a/src/lib/eina/eina_alloca.h b/src/lib/eina/eina_alloca.h
index 9339c68b3b..c0e1b10217 100644
--- a/src/lib/eina/eina_alloca.h
+++ b/src/lib/eina/eina_alloca.h
@@ -44,7 +44,7 @@ extern "C"
44# endif 44# endif
45/** 45/**
46 * Allocates memory in the stack frame of the caller, so it's automatically 46 * Allocates memory in the stack frame of the caller, so it's automatically
47 * freed when the caller returns. See alloca(3) for detials. 47 * freed when the caller returns. See alloca(3) for details.
48 */ 48 */
49void *alloca(size_t size); 49void *alloca(size_t size);
50# endif 50# endif
diff --git a/src/lib/eina/eina_array.h b/src/lib/eina/eina_array.h
index f4e363a2fd..c17fbd9dd0 100644
--- a/src/lib/eina/eina_array.h
+++ b/src/lib/eina/eina_array.h
@@ -177,7 +177,7 @@
177 * array it @b may shrink. 177 * array it @b may shrink.
178 * 178 *
179 * Allocating memory is expensive, so when the array needs to grow it allocates 179 * Allocating memory is expensive, so when the array needs to grow it allocates
180 * enough memory to hold @p step additonal elements, not just the element 180 * enough memory to hold @p step additional elements, not just the element
181 * currently being added. Similarly if you remove elements, it won't free space 181 * currently being added. Similarly if you remove elements, it won't free space
182 * until you have removed @p step elements. 182 * until you have removed @p step elements.
183 * 183 *
@@ -242,7 +242,7 @@ struct _Eina_Array
242 242
243 243
244/** 244/**
245 * @brief Create a new array. 245 * @brief Creates a new array.
246 * 246 *
247 * @param step The count of pointers to add when increasing the array size. 247 * @param step The count of pointers to add when increasing the array size.
248 * @return @c NULL on failure, non @c NULL otherwise. 248 * @return @c NULL on failure, non @c NULL otherwise.
@@ -257,7 +257,7 @@ struct _Eina_Array
257EAPI Eina_Array *eina_array_new(unsigned int step) EINA_WARN_UNUSED_RESULT EINA_MALLOC EINA_WARN_UNUSED_RESULT; 257EAPI Eina_Array *eina_array_new(unsigned int step) EINA_WARN_UNUSED_RESULT EINA_MALLOC EINA_WARN_UNUSED_RESULT;
258 258
259/** 259/**
260 * @brief Free an array. 260 * @brief Frees an array.
261 * 261 *
262 * @param array The array to free. 262 * @param array The array to free.
263 * 263 *
@@ -269,7 +269,7 @@ EAPI Eina_Array *eina_array_new(unsigned int step) EINA_WARN_UNUSED_RESULT EINA_
269EAPI void eina_array_free(Eina_Array *array); 269EAPI void eina_array_free(Eina_Array *array);
270 270
271/** 271/**
272 * @brief Set the step of an array. 272 * @brief Sets the step of an array.
273 * 273 *
274 * @param array The array. 274 * @param array The array.
275 * @param sizeof_eina_array Should be the value returned by sizeof(Eina_Array). 275 * @param sizeof_eina_array Should be the value returned by sizeof(Eina_Array).
@@ -285,7 +285,7 @@ EAPI void eina_array_step_set(Eina_Array *array,
285 unsigned int sizeof_eina_array, 285 unsigned int sizeof_eina_array,
286 unsigned int step) EINA_ARG_NONNULL(1); 286 unsigned int step) EINA_ARG_NONNULL(1);
287/** 287/**
288 * @brief Clean an array. 288 * @brief Cleans an array.
289 * 289 *
290 * @param array The array to clean. 290 * @param array The array to clean.
291 * 291 *
@@ -297,7 +297,7 @@ EAPI void eina_array_step_set(Eina_Array *array,
297static inline void eina_array_clean(Eina_Array *array) EINA_ARG_NONNULL(1); 297static inline void eina_array_clean(Eina_Array *array) EINA_ARG_NONNULL(1);
298 298
299/** 299/**
300 * @brief Flush an array. 300 * @brief Flushes an array.
301 * 301 *
302 * @param array The array to flush. 302 * @param array The array to flush.
303 * 303 *
@@ -309,7 +309,7 @@ static inline void eina_array_clean(Eina_Array *array) EINA_ARG_NONNULL(1);
309EAPI void eina_array_flush(Eina_Array *array) EINA_ARG_NONNULL(1); 309EAPI void eina_array_flush(Eina_Array *array) EINA_ARG_NONNULL(1);
310 310
311/** 311/**
312 * @brief Rebuild an array by specifying the data to keep. 312 * @brief Rebuilds an array by specifying the data to keep.
313 * 313 *
314 * @param array The array. 314 * @param array The array.
315 * @param keep The functions which selects the data to keep. 315 * @param keep The functions which selects the data to keep.
@@ -329,7 +329,7 @@ EAPI Eina_Bool eina_array_remove(Eina_Array * array,
329 void *gdata) EINA_ARG_NONNULL(1, 2); 329 void *gdata) EINA_ARG_NONNULL(1, 2);
330 330
331/** 331/**
332 * @brief Append a data to an array. 332 * @brief Appends a data to an array.
333 * 333 *
334 * @param array The array. 334 * @param array The array.
335 * @param data The data to add. 335 * @param data The data to add.
@@ -345,7 +345,7 @@ static inline Eina_Bool eina_array_push(Eina_Array *array,
345 const void *data) EINA_ARG_NONNULL(1, 2); 345 const void *data) EINA_ARG_NONNULL(1, 2);
346 346
347/** 347/**
348 * @brief Remove the last data of an array. 348 * @brief Removes the last data of an array.
349 * 349 *
350 * @param array The array. 350 * @param array The array.
351 * @return The retrieved data. 351 * @return The retrieved data.
@@ -359,10 +359,10 @@ static inline Eina_Bool eina_array_push(Eina_Array *array,
359static inline void *eina_array_pop(Eina_Array *array) EINA_ARG_NONNULL(1); 359static inline void *eina_array_pop(Eina_Array *array) EINA_ARG_NONNULL(1);
360 360
361/** 361/**
362 * @brief Return the data at a given position in an array. 362 * @brief Returns the data at a given position in an array.
363 * 363 *
364 * @param array The array. 364 * @param array The array.
365 * @param idx The potition of the data to retrieve. 365 * @param idx The position of the data to retrieve.
366 * @return The retrieved data. 366 * @return The retrieved data.
367 * 367 *
368 * This function returns the data at the position @p idx in @p 368 * This function returns the data at the position @p idx in @p
@@ -372,7 +372,7 @@ static inline void *eina_array_pop(Eina_Array *array) EINA_ARG_NONNULL(1);
372static inline void *eina_array_data_get(const Eina_Array *array, 372static inline void *eina_array_data_get(const Eina_Array *array,
373 unsigned int idx) EINA_ARG_NONNULL(1); 373 unsigned int idx) EINA_ARG_NONNULL(1);
374/** 374/**
375 * @brief Set the data at a given position in an array. 375 * @brief Sets the data at a given position in an array.
376 * 376 *
377 * @param array The array. 377 * @param array The array.
378 * @param idx The position of the data to set. 378 * @param idx The position of the data to set.
@@ -388,7 +388,8 @@ static inline void eina_array_data_set(const Eina_Array *array,
388 unsigned int idx, 388 unsigned int idx,
389 const void *data) EINA_ARG_NONNULL(1); 389 const void *data) EINA_ARG_NONNULL(1);
390/** 390/**
391 * @brief Return the number of elements in an array. 391 * @deprecated use eina_array_count()
392 * @brief Returns the number of elements in an array.
392 * 393 *
393 * @param array The array. 394 * @param array The array.
394 * @return The number of elements. 395 * @return The number of elements.
@@ -397,12 +398,11 @@ static inline void eina_array_data_set(const Eina_Array *array,
397 * performance reasons, there is no check of @p array. If it is 398 * performance reasons, there is no check of @p array. If it is
398 * @c NULL or invalid, the program may crash. 399 * @c NULL or invalid, the program may crash.
399 * 400 *
400 * @deprecated use eina_array_count()
401 */ 401 */
402static inline unsigned int eina_array_count_get(const Eina_Array *array) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; 402static inline unsigned int eina_array_count_get(const Eina_Array *array) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
403 403
404/** 404/**
405 * @brief Return the number of elements in an array. 405 * @brief Returns the number of elements in an array.
406 * 406 *
407 * @param array The array. 407 * @param array The array.
408 * @return The number of elements. 408 * @return The number of elements.
@@ -414,7 +414,7 @@ static inline unsigned int eina_array_count_get(const Eina_Array *array) EINA_AR
414static inline unsigned int eina_array_count(const Eina_Array *array) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; 414static inline unsigned int eina_array_count(const Eina_Array *array) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
415 415
416/** 416/**
417 * @brief Get a new iterator associated to an array. 417 * @brief Gets a new iterator associated to an array.
418 * 418 *
419 * @param array The array. 419 * @param array The array.
420 * @return A new iterator. 420 * @return A new iterator.
@@ -427,7 +427,7 @@ static inline unsigned int eina_array_count(const Eina_Array *array) EINA_ARG_NO
427EAPI Eina_Iterator *eina_array_iterator_new(const Eina_Array *array) EINA_MALLOC EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; 427EAPI Eina_Iterator *eina_array_iterator_new(const Eina_Array *array) EINA_MALLOC EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
428 428
429/** 429/**
430 * @brief Get a new accessor associated to an array. 430 * @brief Gets a new accessor associated to an array.
431 * 431 *
432 * @param array The array. 432 * @param array The array.
433 * @return A new accessor. 433 * @return A new accessor.
@@ -440,7 +440,7 @@ EAPI Eina_Iterator *eina_array_iterator_new(const Eina_Array *array) EINA
440 */ 440 */
441EAPI Eina_Accessor *eina_array_accessor_new(const Eina_Array *array) EINA_MALLOC EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; 441EAPI Eina_Accessor *eina_array_accessor_new(const Eina_Array *array) EINA_MALLOC EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
442/** 442/**
443 * @brief Provide a safe way to iterate over an array 443 * @brief Provides a safe way to iterate over an array.
444 * 444 *
445 * @param array The array to iterate over. 445 * @param array The array to iterate over.
446 * @param cb The callback to call for each item. 446 * @param cb The callback to call for each item.
@@ -457,7 +457,7 @@ static inline Eina_Bool eina_array_foreach(Eina_Array *array,
457 void *fdata); 457 void *fdata);
458/** 458/**
459 * @def EINA_ARRAY_ITER_NEXT 459 * @def EINA_ARRAY_ITER_NEXT
460 * @brief Macro to iterate over an array easily. 460 * @brief Definition for the macro to iterate over an array easily.
461 * 461 *
462 * @param array The array to iterate over. 462 * @param array The array to iterate over.
463 * @param index The integer number that is increased while iterating. 463 * @param index The integer number that is increased while iterating.
diff --git a/src/lib/eina/eina_benchmark.h b/src/lib/eina/eina_benchmark.h
index 8c0c5988da..b54c984db2 100644
--- a/src/lib/eina/eina_benchmark.h
+++ b/src/lib/eina/eina_benchmark.h
@@ -116,7 +116,7 @@
116 * The first column (specimen) is the integer passed to the work1() 116 * The first column (specimen) is the integer passed to the work1()
117 * function when the test is run. The second column (experiment time) 117 * function when the test is run. The second column (experiment time)
118 * is the time, in nanosecond, that work1() takes. The third and 118 * is the time, in nanosecond, that work1() takes. The third and
119 * fourth columnd are self-explicit. 119 * fourth column are self-explicit.
120 * 120 *
121 * You can see that the integer passed work1() starts from 200 and 121 * You can see that the integer passed work1() starts from 200 and
122 * finishes at 290, with a step of 10. These values are computed withe 122 * finishes at 290, with a step of 10. These values are computed withe
@@ -129,7 +129,7 @@
129 * gnuplot bench_test_run.gnuplot 129 * gnuplot bench_test_run.gnuplot
130 * @endcode 130 * @endcode
131 * 131 *
132 * to create the graphic of the comparison curves. The image file is 132 * To create the graphic of the comparison curves. The image file is
133 * named output_test_run.png. 133 * named output_test_run.png.
134 * 134 *
135 * @section tutorial_benchmark_advanced_usage More Advanced Usage 135 * @section tutorial_benchmark_advanced_usage More Advanced Usage
@@ -345,7 +345,7 @@ typedef void (*Eina_Benchmark_Specimens)(int request);
345 345
346/** 346/**
347 * @def EINA_BENCHMARK 347 * @def EINA_BENCHMARK
348 * @brief cast to an #Eina_Benchmark_Specimens. 348 * @brief Definition for the cast to an #Eina_Benchmark_Specimens.
349 * 349 *
350 * @param function The function to cast. 350 * @param function The function to cast.
351 * 351 *
@@ -355,7 +355,7 @@ typedef void (*Eina_Benchmark_Specimens)(int request);
355 355
356 356
357/** 357/**
358 * @brief Create a new array. 358 * @brief Creates a new array.
359 * 359 *
360 * @param name The name of the benchmark. 360 * @param name The name of the benchmark.
361 * @param run The name of the run. 361 * @param run The name of the run.
@@ -374,7 +374,7 @@ EAPI Eina_Benchmark *eina_benchmark_new(const char *name,
374 const char *run); 374 const char *run);
375 375
376/** 376/**
377 * @brief Free a benchmark object. 377 * @brief Frees a benchmark object.
378 * 378 *
379 * @param bench The benchmark to free. 379 * @param bench The benchmark to free.
380 * 380 *
@@ -385,7 +385,7 @@ EAPI Eina_Benchmark *eina_benchmark_new(const char *name,
385EAPI void eina_benchmark_free(Eina_Benchmark *bench); 385EAPI void eina_benchmark_free(Eina_Benchmark *bench);
386 386
387/** 387/**
388 * @brief Add a test to a benchmark. 388 * @brief Adds a test to a benchmark.
389 * 389 *
390 * @param bench The benchmark. 390 * @param bench The benchmark.
391 * @param name The name of the test. 391 * @param name The name of the test.
@@ -413,7 +413,7 @@ EAPI Eina_Bool eina_benchmark_register(Eina_Benchmark *bench,
413 int count_step); 413 int count_step);
414 414
415/** 415/**
416 * @brief Run the benchmark tests that have been registered. 416 * @brief Runs the benchmark tests that have been registered.
417 * 417 *
418 * @param bench The benchmark. 418 * @param bench The benchmark.
419 * @return The list of names of the test files. 419 * @return The list of names of the test files.
@@ -426,7 +426,7 @@ EAPI Eina_Bool eina_benchmark_register(Eina_Benchmark *bench,
426 * bench_[name]_[run]%s.gnuplot 426 * bench_[name]_[run]%s.gnuplot
427 * @endcode 427 * @endcode
428 * 428 *
429 * where [name] and [run] are the values passed to 429 * Where [name] and [run] are the values passed to
430 * eina_benchmark_new(). 430 * eina_benchmark_new().
431 * 431 *
432 * Each registered test is executed and timed. The time is written to 432 * Each registered test is executed and timed. The time is written to
diff --git a/src/lib/eina/eina_bezier.h b/src/lib/eina/eina_bezier.h
index e8d1a7bcbe..dfbee11d4e 100644
--- a/src/lib/eina/eina_bezier.h
+++ b/src/lib/eina/eina_bezier.h
@@ -48,7 +48,7 @@ struct _Eina_Bezier
48}; 48};
49 49
50/** 50/**
51 * @brief Set the values of the points of the given floating 51 * @brief Sets the values of the points of the given floating
52 * point cubic bezier curve. 52 * point cubic bezier curve.
53 * 53 *
54 * @param b The floating point bezier. 54 * @param b The floating point bezier.
@@ -67,7 +67,7 @@ struct _Eina_Bezier
67EAPI void eina_bezier_values_set(Eina_Bezier *b, double start_x, double start_y, double ctrl_start_x, double ctrl_start_y, double ctrl_end_x, double ctrl_end_y, double end_x, double end_y) EINA_ARG_NONNULL(1); 67EAPI void eina_bezier_values_set(Eina_Bezier *b, double start_x, double start_y, double ctrl_start_x, double ctrl_start_y, double ctrl_end_x, double ctrl_end_y, double end_x, double end_y) EINA_ARG_NONNULL(1);
68 68
69/** 69/**
70 * @brief Get the values of the points of the given floating 70 * @brief Gets the values of the points of the given floating
71 * point cubic bezier curve. 71 * point cubic bezier curve.
72 * 72 *
73 * @param b The floating point bezier. 73 * @param b The floating point bezier.
@@ -133,7 +133,7 @@ EAPI void eina_bezier_point_at(const Eina_Bezier *b, double t, double *px, doubl
133EAPI double eina_bezier_angle_at(const Eina_Bezier *b, double t) EINA_ARG_NONNULL(1); 133EAPI double eina_bezier_angle_at(const Eina_Bezier *b, double t) EINA_ARG_NONNULL(1);
134 134
135/** 135/**
136 * @brief split the bezier at given length. 136 * @brief Splits the bezier at given length.
137 * 137 *
138 * @param b The floating point bezier. 138 * @param b The floating point bezier.
139 * @param len The given length. 139 * @param len The given length.
@@ -144,7 +144,7 @@ EAPI double eina_bezier_angle_at(const Eina_Bezier *b, double t) EINA_ARG_NONNUL
144EAPI void eina_bezier_split_at_length(const Eina_Bezier *b, double len, Eina_Bezier *left, Eina_Bezier *right) EINA_ARG_NONNULL(1); 144EAPI void eina_bezier_split_at_length(const Eina_Bezier *b, double len, Eina_Bezier *left, Eina_Bezier *right) EINA_ARG_NONNULL(1);
145 145
146/** 146/**
147 * @brief get the bound of the the bezier. 147 * @brief Gets the bound of the the bezier.
148 * 148 *
149 * @param b The floating point bezier. 149 * @param b The floating point bezier.
150 * @param x x coordinate of bounding box. 150 * @param x x coordinate of bounding box.
@@ -158,7 +158,7 @@ EAPI void eina_bezier_split_at_length(const Eina_Bezier *b, double len, Eina_Bez
158EAPI void eina_bezier_bounds_get(const Eina_Bezier *b, double *x, double *y, double *w, double *h) EINA_ARG_NONNULL(1); 158EAPI void eina_bezier_bounds_get(const Eina_Bezier *b, double *x, double *y, double *w, double *h) EINA_ARG_NONNULL(1);
159 159
160/** 160/**
161 * @brief find the bezier at given interval. 161 * @brief Finds the bezier at given interval.
162 * 162 *
163 * @param b The floating point bezier. 163 * @param b The floating point bezier.
164 * @param t0 The start interval. 164 * @param t0 The start interval.
diff --git a/src/lib/eina/eina_binbuf.h b/src/lib/eina/eina_binbuf.h
index fe5fc4ef37..0aa0e1a117 100644
--- a/src/lib/eina/eina_binbuf.h
+++ b/src/lib/eina/eina_binbuf.h
@@ -34,7 +34,7 @@
34typedef struct _Eina_Strbuf Eina_Binbuf; 34typedef struct _Eina_Strbuf Eina_Binbuf;
35 35
36/** 36/**
37 * @brief Create a new string buffer. 37 * @brief Creates a new string buffer.
38 * 38 *
39 * @return Newly allocated string buffer instance. 39 * @return Newly allocated string buffer instance.
40 * 40 *
@@ -48,12 +48,12 @@ typedef struct _Eina_Strbuf Eina_Binbuf;
48EAPI Eina_Binbuf *eina_binbuf_new(void) EINA_MALLOC EINA_WARN_UNUSED_RESULT; 48EAPI Eina_Binbuf *eina_binbuf_new(void) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
49 49
50/** 50/**
51 * @brief Create a new string buffer using the passed string. The passed 51 * @brief Creates a new string buffer using the passed string. The passed
52 * string is used directly as the buffer, it's somehow the opposite function of 52 * string is used directly as the buffer, it's somehow the opposite function of
53 * @ref eina_binbuf_string_steal . The passed string must be malloced. 53 * @ref eina_binbuf_string_steal . The passed string must be malloced.
54 * 54 *
55 * @param str the string to manage 55 * @param str The string to manage.
56 * @param length the length of the string. 56 * @param length The length of the string.
57 * @return Newly allocated string buffer instance. 57 * @return Newly allocated string buffer instance.
58 * 58 *
59 * This function creates a new string buffer. On error, @c NULL is 59 * This function creates a new string buffer. On error, @c NULL is
@@ -65,13 +65,13 @@ EAPI Eina_Binbuf *eina_binbuf_new(void) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
65EAPI Eina_Binbuf *eina_binbuf_manage_new_length(unsigned char *str, size_t length) EINA_MALLOC EINA_WARN_UNUSED_RESULT EINA_DEPRECATED; 65EAPI Eina_Binbuf *eina_binbuf_manage_new_length(unsigned char *str, size_t length) EINA_MALLOC EINA_WARN_UNUSED_RESULT EINA_DEPRECATED;
66 66
67/** 67/**
68 * @brief Create a new string buffer using the passed string. The passed 68 * @brief Creates a new string buffer using the passed string. The passed
69 * string is used directly as the buffer, it's somehow the opposite function of 69 * string is used directly as the buffer, it's somehow the opposite function of
70 * @ref eina_binbuf_string_steal . 70 * @ref eina_binbuf_string_steal .
71 * 71 *
72 * @param str the string to start from 72 * @param str The string to start from.
73 * @param length the length of the string. 73 * @param length The length of the string.
74 * @param ro the passed string will not be touched if set to EINA_TRUE. 74 * @param ro The passed string will not be touched if set to EINA_TRUE.
75 * @return Newly allocated string buffer instance. 75 * @return Newly allocated string buffer instance.
76 * 76 *
77 * This function creates a new string buffer. On error, @c NULL is 77 * This function creates a new string buffer. On error, @c NULL is
@@ -90,12 +90,12 @@ EAPI Eina_Binbuf *eina_binbuf_manage_new_length(unsigned char *str, size_t lengt
90EAPI Eina_Binbuf *eina_binbuf_manage_new(const unsigned char *str, size_t length, Eina_Bool ro) EINA_MALLOC EINA_WARN_UNUSED_RESULT; 90EAPI Eina_Binbuf *eina_binbuf_manage_new(const unsigned char *str, size_t length, Eina_Bool ro) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
91 91
92/** 92/**
93 * @brief Create a new string buffer using the passed string. The passed 93 * @brief Creates a new string buffer using the passed string. The passed
94 * string is used directly as the buffer, it's somehow the opposite function of 94 * string is used directly as the buffer, it's somehow the opposite function of
95 * @ref eina_binbuf_string_steal . The passed string will not be touched. 95 * @ref eina_binbuf_string_steal . The passed string will not be touched.
96 * 96 *
97 * @param str the string to start from 97 * @param str The string to start from.
98 * @param length the length of the string. 98 * @param length The length of the string.
99 * @return Newly allocated string buffer instance. 99 * @return Newly allocated string buffer instance.
100 * 100 *
101 * This function creates a new string buffer. On error, @c NULL is 101 * This function creates a new string buffer. On error, @c NULL is
@@ -110,7 +110,7 @@ EAPI Eina_Binbuf *eina_binbuf_manage_new(const unsigned char *str, size_t length
110EAPI Eina_Binbuf *eina_binbuf_manage_read_only_new_length(const unsigned char *str, size_t length) EINA_MALLOC EINA_WARN_UNUSED_RESULT EINA_DEPRECATED; 110EAPI Eina_Binbuf *eina_binbuf_manage_read_only_new_length(const unsigned char *str, size_t length) EINA_MALLOC EINA_WARN_UNUSED_RESULT EINA_DEPRECATED;
111 111
112/** 112/**
113 * @brief Free a string buffer. 113 * @brief Frees a string buffer.
114 * 114 *
115 * @param buf The string buffer to free. 115 * @param buf The string buffer to free.
116 * 116 *
@@ -120,7 +120,7 @@ EAPI Eina_Binbuf *eina_binbuf_manage_read_only_new_length(const unsigned char *s
120EAPI void eina_binbuf_free(Eina_Binbuf *buf) EINA_ARG_NONNULL(1); 120EAPI void eina_binbuf_free(Eina_Binbuf *buf) EINA_ARG_NONNULL(1);
121 121
122/** 122/**
123 * @brief Reset a string buffer. 123 * @brief Resets a string buffer.
124 * 124 *
125 * @param buf The string buffer to reset. 125 * @param buf The string buffer to reset.
126 * 126 *
@@ -130,7 +130,7 @@ EAPI void eina_binbuf_free(Eina_Binbuf *buf) EINA_ARG_NONNULL(1);
130EAPI void eina_binbuf_reset(Eina_Binbuf *buf) EINA_ARG_NONNULL(1); 130EAPI void eina_binbuf_reset(Eina_Binbuf *buf) EINA_ARG_NONNULL(1);
131 131
132/** 132/**
133 * @brief Expand a buffer, making room for at least @a minimum_unused_space. 133 * @brief Expands a buffer, making room for at least @a minimum_unused_space.
134 * 134 *
135 * One of the properties of the buffer is that it may overallocate 135 * One of the properties of the buffer is that it may overallocate
136 * space, thus it may have more than eina_binbuf_length_get() bytes 136 * space, thus it may have more than eina_binbuf_length_get() bytes
@@ -161,7 +161,7 @@ EAPI void eina_binbuf_reset(Eina_Binbuf *buf) EINA_ARG_NONNULL(1);
161EAPI Eina_Rw_Slice eina_binbuf_expand(Eina_Binbuf *buf, size_t minimum_unused_space) EINA_ARG_NONNULL(1); 161EAPI Eina_Rw_Slice eina_binbuf_expand(Eina_Binbuf *buf, size_t minimum_unused_space) EINA_ARG_NONNULL(1);
162 162
163/** 163/**
164 * @brief Mark more bytes as used. 164 * @brief Marks more bytes as used.
165 * 165 *
166 * This function should be used after eina_binbuf_expand(), marking 166 * This function should be used after eina_binbuf_expand(), marking
167 * the extra bytes returned there as used, then they will be 167 * the extra bytes returned there as used, then they will be
@@ -182,7 +182,7 @@ EAPI Eina_Rw_Slice eina_binbuf_expand(Eina_Binbuf *buf, size_t minimum_unused_sp
182EAPI Eina_Bool eina_binbuf_use(Eina_Binbuf *buf, size_t extra_bytes) EINA_ARG_NONNULL(1); 182EAPI Eina_Bool eina_binbuf_use(Eina_Binbuf *buf, size_t extra_bytes) EINA_ARG_NONNULL(1);
183 183
184/** 184/**
185 * @brief Append a string of exact length to a buffer, reallocating as necessary. 185 * @brief Appends a string of exact length to a buffer, reallocating as necessary.
186 * 186 *
187 * @param buf The string buffer to append to. 187 * @param buf The string buffer to append to.
188 * @param str The string to append. 188 * @param str The string to append.
@@ -203,7 +203,7 @@ EAPI Eina_Bool eina_binbuf_use(Eina_Binbuf *buf, size_t extra_bytes) EINA_ARG_NO
203EAPI Eina_Bool eina_binbuf_append_length(Eina_Binbuf *buf, const unsigned char *str, size_t length) EINA_ARG_NONNULL(1, 2); 203EAPI Eina_Bool eina_binbuf_append_length(Eina_Binbuf *buf, const unsigned char *str, size_t length) EINA_ARG_NONNULL(1, 2);
204 204
205/** 205/**
206 * @brief Append a slice to a buffer, reallocating as necessary. 206 * @brief Appends a slice to a buffer, reallocating as necessary.
207 * 207 *
208 * @param buf The string buffer to append to. 208 * @param buf The string buffer to append to.
209 * @param slice The slice to append. 209 * @param slice The slice to append.
@@ -217,7 +217,7 @@ EAPI Eina_Bool eina_binbuf_append_length(Eina_Binbuf *buf, const unsigned char *
217EAPI Eina_Bool eina_binbuf_append_slice(Eina_Binbuf *buf, const Eina_Slice slice) EINA_ARG_NONNULL(1); 217EAPI Eina_Bool eina_binbuf_append_slice(Eina_Binbuf *buf, const Eina_Slice slice) EINA_ARG_NONNULL(1);
218 218
219/** 219/**
220 * @brief Append an Eina_Binbuf to a buffer, reallocating as necessary. 220 * @brief Appends an Eina_Binbuf to a buffer, reallocating as necessary.
221 * 221 *
222 * @param buf The string buffer to append to. 222 * @param buf The string buffer to append to.
223 * @param data The string buffer to append. 223 * @param data The string buffer to append.
@@ -236,7 +236,7 @@ EAPI Eina_Bool eina_binbuf_append_slice(Eina_Binbuf *buf, const Eina_Slice slice
236EAPI Eina_Bool eina_binbuf_append_buffer(Eina_Binbuf *buf, const Eina_Binbuf *data) EINA_ARG_NONNULL(1, 2); 236EAPI Eina_Bool eina_binbuf_append_buffer(Eina_Binbuf *buf, const Eina_Binbuf *data) EINA_ARG_NONNULL(1, 2);
237 237
238/** 238/**
239 * @brief Append a character to a string buffer, reallocating as 239 * @brief Appends a character to a string buffer, reallocating as
240 * necessary. 240 * necessary.
241 * 241 *
242 * @param buf The string buffer to append to. 242 * @param buf The string buffer to append to.
@@ -249,7 +249,7 @@ EAPI Eina_Bool eina_binbuf_append_buffer(Eina_Binbuf *buf, const Eina_Binbuf *da
249EAPI Eina_Bool eina_binbuf_append_char(Eina_Binbuf *buf, unsigned char c) EINA_ARG_NONNULL(1); 249EAPI Eina_Bool eina_binbuf_append_char(Eina_Binbuf *buf, unsigned char c) EINA_ARG_NONNULL(1);
250 250
251/** 251/**
252 * @brief Insert a string of exact length to a buffer, reallocating as necessary. 252 * @brief Inserts a string of exact length to a buffer, reallocating as necessary.
253 * 253 *
254 * @param buf The string buffer to insert to. 254 * @param buf The string buffer to insert to.
255 * @param str The string to insert. 255 * @param str The string to insert.
@@ -271,7 +271,7 @@ EAPI Eina_Bool eina_binbuf_append_char(Eina_Binbuf *buf, unsigned char c) EINA_A
271EAPI Eina_Bool eina_binbuf_insert_length(Eina_Binbuf *buf, const unsigned char *str, size_t length, size_t pos) EINA_ARG_NONNULL(1, 2); 271EAPI Eina_Bool eina_binbuf_insert_length(Eina_Binbuf *buf, const unsigned char *str, size_t length, size_t pos) EINA_ARG_NONNULL(1, 2);
272 272
273/** 273/**
274 * @brief Insert a slice to a buffer, reallocating as necessary. 274 * @brief Inserts a slice to a buffer, reallocating as necessary.
275 * 275 *
276 * @param buf The string buffer to insert to. 276 * @param buf The string buffer to insert to.
277 * @param slice The slice to insert. 277 * @param slice The slice to insert.
@@ -287,7 +287,7 @@ EAPI Eina_Bool eina_binbuf_insert_length(Eina_Binbuf *buf, const unsigned char *
287EAPI Eina_Bool eina_binbuf_insert_slice(Eina_Binbuf *buf, const Eina_Slice slice, size_t pos) EINA_ARG_NONNULL(1); 287EAPI Eina_Bool eina_binbuf_insert_slice(Eina_Binbuf *buf, const Eina_Slice slice, size_t pos) EINA_ARG_NONNULL(1);
288 288
289/** 289/**
290 * @brief Insert a character to a string buffer, reallocating as 290 * @brief Inserts a character to a string buffer, reallocating as
291 * necessary. 291 * necessary.
292 * 292 *
293 * @param buf The string buffer to insert to. 293 * @param buf The string buffer to insert to.
@@ -302,7 +302,7 @@ EAPI Eina_Bool eina_binbuf_insert_slice(Eina_Binbuf *buf, const Eina_Slice slice
302EAPI Eina_Bool eina_binbuf_insert_char(Eina_Binbuf *buf, unsigned char c, size_t pos) EINA_ARG_NONNULL(1); 302EAPI Eina_Bool eina_binbuf_insert_char(Eina_Binbuf *buf, unsigned char c, size_t pos) EINA_ARG_NONNULL(1);
303 303
304/** 304/**
305 * @brief Remove a slice of the given string buffer. 305 * @brief Removes a slice of the given string buffer.
306 * 306 *
307 * @param buf The string buffer to remove a slice. 307 * @param buf The string buffer to remove a slice.
308 * @param start The initial (inclusive) slice position to start 308 * @param start The initial (inclusive) slice position to start
@@ -319,7 +319,7 @@ EAPI Eina_Bool eina_binbuf_insert_char(Eina_Binbuf *buf, unsigned char c, size_t
319EAPI Eina_Bool eina_binbuf_remove(Eina_Binbuf *buf, size_t start, size_t end) EINA_ARG_NONNULL(1); 319EAPI Eina_Bool eina_binbuf_remove(Eina_Binbuf *buf, size_t start, size_t end) EINA_ARG_NONNULL(1);
320 320
321/** 321/**
322 * @brief Retrieve a pointer to the contents of a string buffer 322 * @brief Retrieves a pointer to the contents of a string buffer.
323 * 323 *
324 * @param buf The string buffer. 324 * @param buf The string buffer.
325 * @return The current string in the string buffer. 325 * @return The current string in the string buffer.
@@ -334,7 +334,7 @@ EAPI Eina_Bool eina_binbuf_remove(Eina_Binbuf *buf, size_t start, size_t end) EI
334EAPI const unsigned char *eina_binbuf_string_get(const Eina_Binbuf *buf) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; 334EAPI const unsigned char *eina_binbuf_string_get(const Eina_Binbuf *buf) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
335 335
336/** 336/**
337 * @brief Steal the contents of a string buffer. 337 * @brief Steals the contents of a string buffer.
338 * 338 *
339 * @param buf The string buffer to steal. 339 * @param buf The string buffer to steal.
340 * @return The current string in the string buffer. 340 * @return The current string in the string buffer.
@@ -349,7 +349,7 @@ EAPI const unsigned char *eina_binbuf_string_get(const Eina_Binbuf *buf) EINA_AR
349EAPI unsigned char *eina_binbuf_string_steal(Eina_Binbuf *buf) EINA_MALLOC EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); 349EAPI unsigned char *eina_binbuf_string_steal(Eina_Binbuf *buf) EINA_MALLOC EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
350 350
351/** 351/**
352 * @brief Free the contents of a string buffer but not the buffer. 352 * @brief Frees the contents of a string buffer but not the buffer.
353 * 353 *
354 * @param buf The string buffer to free the string of. 354 * @param buf The string buffer to free the string of.
355 * 355 *
@@ -359,7 +359,7 @@ EAPI unsigned char *eina_binbuf_string_steal(Eina_Binbuf *buf) EINA_MALLOC EINA_
359EAPI void eina_binbuf_string_free(Eina_Binbuf *buf) EINA_ARG_NONNULL(1); 359EAPI void eina_binbuf_string_free(Eina_Binbuf *buf) EINA_ARG_NONNULL(1);
360 360
361/** 361/**
362 * @brief Retrieve the length of the string buffer content. 362 * @brief Retrieves the length of the string buffer content.
363 * 363 *
364 * @param buf The string buffer. 364 * @param buf The string buffer.
365 * @return The current length of the string, in bytes. 365 * @return The current length of the string, in bytes.
@@ -369,7 +369,7 @@ EAPI void eina_binbuf_string_free(Eina_Binbuf *buf) EINA_ARG_NONNULL(1);
369EAPI size_t eina_binbuf_length_get(const Eina_Binbuf *buf) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; 369EAPI size_t eina_binbuf_length_get(const Eina_Binbuf *buf) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
370 370
371/** 371/**
372 * @brief Get a read-only slice representing the current binbuf contents. 372 * @brief Gets a read-only slice representing the current binbuf contents.
373 * 373 *
374 * @param buf the src buffer. 374 * @param buf the src buffer.
375 * @return a read-only slice for the current contents. It may become 375 * @return a read-only slice for the current contents. It may become
@@ -380,7 +380,7 @@ EAPI size_t eina_binbuf_length_get(const Eina_Binbuf *buf) EINA_ARG_NONNULL(1
380EAPI Eina_Slice eina_binbuf_slice_get(const Eina_Binbuf *buf) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); 380EAPI Eina_Slice eina_binbuf_slice_get(const Eina_Binbuf *buf) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
381 381
382/** 382/**
383 * @brief Get a read-write slice representing the current binbuf contents. 383 * @brief Gets a read-write slice representing the current binbuf contents.
384 * 384 *
385 * @param buf the src buffer. 385 * @param buf the src buffer.
386 * @return a read-write slice for the current contents. It may become 386 * @return a read-write slice for the current contents. It may become
@@ -393,7 +393,7 @@ EAPI Eina_Slice eina_binbuf_slice_get(const Eina_Binbuf *buf) EINA_WARN_UNUSED_R
393 */ 393 */
394EAPI Eina_Rw_Slice eina_binbuf_rw_slice_get(const Eina_Binbuf *buf) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); 394EAPI Eina_Rw_Slice eina_binbuf_rw_slice_get(const Eina_Binbuf *buf) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
395/** 395/**
396 * @brief Get the content of the buffer and free the buffer 396 * @brief Gets the content of the buffer and free the buffer.
397 * 397 *
398 * @param buf the buffer to get the content from and which will be freed 398 * @param buf the buffer to get the content from and which will be freed
399 * 399 *
diff --git a/src/lib/eina/eina_binshare.h b/src/lib/eina/eina_binshare.h
index 9015c78461..af9781dbf4 100644
--- a/src/lib/eina/eina_binshare.h
+++ b/src/lib/eina/eina_binshare.h
@@ -129,14 +129,12 @@ EAPI void eina_binshare_del(const void *obj);
129 129
130/** 130/**
131 * @brief Notes that the given object @b must be shared. 131 * @brief Notes that the given object @b must be shared.
132 * 132 * @details This function is a cheap way to know the length of a shared
133 * object.
133 * @param[in] obj The shared object to know the length \n 134 * @param[in] obj The shared object to know the length \n
134 * It is safe to give @c NULL, in which case @c -1 is returned 135 * It is safe to give @c NULL, in which case @c -1 is returned
135 * @return The length of the shared object 136 * @return The length of the shared object
136 * 137 *
137 * @details This function is a cheap way to know the length of a shared
138 * object.
139 *
140 * @warning If the given pointer is not shared, bad things happen, mostly a 138 * @warning If the given pointer is not shared, bad things happen, mostly a
141 * segmentation fault. If in doubt, try strlen(). 139 * segmentation fault. If in doubt, try strlen().
142 */ 140 */
@@ -152,16 +150,14 @@ EAPI void eina_binshare_dump(void);
152 150
153/** 151/**
154 * @brief Retrieves an instance of a blob for use in a program. 152 * @brief Retrieves an instance of a blob for use in a program.
155 *
156 * @param ptr The binary blob to retrieve an instance of
157 * @return A pointer to an instance of the string on success,
158 * otherwise @c NULL on failure
159 *
160 * @details This macro retrieves an instance of @p obj. If @p obj is 153 * @details This macro retrieves an instance of @p obj. If @p obj is
161 * @c NULL, then @c NULL is returned. If @p obj is already stored, it 154 * @c NULL, then @c NULL is returned. If @p obj is already stored, it
162 * is just returned and its reference counter is increased. Otherwise 155 * is just returned and its reference counter is increased. Otherwise
163 * it is added to the blobs to be searched and a duplicated blob 156 * it is added to the blobs to be searched and a duplicated blob
164 * of @p obj is returned. 157 * of @p obj is returned.
158 * @param ptr The binary blob to retrieve an instance of
159 * @return A pointer to an instance of the string on success,
160 * otherwise @c NULL on failure
165 * 161 *
166 * @note This macro essentially calls eina_binshare_add_length with ptr and sizeof(*ptr) 162 * @note This macro essentially calls eina_binshare_add_length with ptr and sizeof(*ptr)
167 * as the parameters. It's useful for pointers to structures. 163 * as the parameters. It's useful for pointers to structures.
diff --git a/src/lib/eina/eina_clist.h b/src/lib/eina/eina_clist.h
index 8f3e2e90aa..e927a9bc25 100644
--- a/src/lib/eina/eina_clist.h
+++ b/src/lib/eina/eina_clist.h
@@ -169,14 +169,13 @@ static inline void eina_clist_add_tail(Eina_Clist *list, Eina_Clist *elem);
169 169
170/** 170/**
171 * @brief Inits an (unlinked) element. 171 * @brief Inits an (unlinked) element.
172 * @details This function is called on elements that have not been added to the list
173 * so that eina_clist_element_init() works correctly.
172 * 174 *
173 * @param[in] elem An element 175 * @param[in] elem An element
174 * @pre The element is not in any list. 176 * @pre The element is not in any list.
175 * @post The element is marked as not being in any list. 177 * @post The element is marked as not being in any list.
176 * 178 *
177 * @details This function is called on elements that have not been added to the list
178 * so that eina_clist_element_init() works correctly.
179 *
180 * @note It is not necessary to call this before adding an element to this list. 179 * @note It is not necessary to call this before adding an element to this list.
181 * 180 *
182 * @since 1.1.0 181 * @since 1.1.0
@@ -324,7 +323,7 @@ static inline void eina_clist_move_head(Eina_Clist *dst, Eina_Clist *src);
324 * @brief Iterates through the list, with safety against removal. 323 * @brief Iterates through the list, with safety against removal.
325 * 324 *
326 * @param cursor The pointer to be used during the interaction 325 * @param cursor The pointer to be used during the interaction
327 * @param cursor2 The auxiliar pointer to be used during the interaction 326 * @param cursor2 The auxiliary pointer to be used during the interaction
328 * @param list The list to be interacted with 327 * @param list The list to be interacted with
329 */ 328 */
330#define EINA_CLIST_FOR_EACH_SAFE(cursor, cursor2, list) \ 329#define EINA_CLIST_FOR_EACH_SAFE(cursor, cursor2, list) \
@@ -351,7 +350,7 @@ static inline void eina_clist_move_head(Eina_Clist *dst, Eina_Clist *src);
351 * @brief Iterates through the list using a list entry, with safety against removal. 350 * @brief Iterates through the list using a list entry, with safety against removal.
352 * 351 *
353 * @param cursor The pointer to be used during the interaction 352 * @param cursor The pointer to be used during the interaction
354 * @param cursor2 The auxiliar pointer to be used during the interaction 353 * @param cursor2 The auxiliary pointer to be used during the interaction
355 * @param list The list to be interacted with 354 * @param list The list to be interacted with
356 * @param type The type of the list 355 * @param type The type of the list
357 * @param field The field of the element 356 * @param field The field of the element
@@ -378,7 +377,7 @@ static inline void eina_clist_move_head(Eina_Clist *dst, Eina_Clist *src);
378 * @brief Iterates through the list in the reverse order, with safety against removal. 377 * @brief Iterates through the list in the reverse order, with safety against removal.
379 * 378 *
380 * @param cursor The pointer to be used during the interaction 379 * @param cursor The pointer to be used during the interaction
381 * @param cursor2 The auxiliar pointer to be used during the interaction 380 * @param cursor2 The auxiliary pointer to be used during the interaction
382 * @param list The list to be interacted with 381 * @param list The list to be interacted with
383 */ 382 */
384#define EINA_CLIST_FOR_EACH_SAFE_REV(cursor, cursor2, list) \ 383#define EINA_CLIST_FOR_EACH_SAFE_REV(cursor, cursor2, list) \
@@ -406,7 +405,7 @@ static inline void eina_clist_move_head(Eina_Clist *dst, Eina_Clist *src);
406 * removal. 405 * removal.
407 * 406 *
408 * @param cursor The pointer to be used during the interaction 407 * @param cursor The pointer to be used during the interaction
409 * @param cursor2 The auxiliar pointer to be used during the interaction 408 * @param cursor2 The auxiliary pointer to be used during the interaction
410 * @param list The list to be interacted with 409 * @param list The list to be interacted with
411 * @param type The type of the list 410 * @param type The type of the list
412 * @param field The field of the element 411 * @param field The field of the element
diff --git a/src/lib/eina/eina_convert.h b/src/lib/eina/eina_convert.h
index be65cc404e..1234e4cf50 100644
--- a/src/lib/eina/eina_convert.h
+++ b/src/lib/eina/eina_convert.h
@@ -92,15 +92,15 @@
92 * 92 *
93 * To convert a string to a double, eina_convert_atod() should be 93 * To convert a string to a double, eina_convert_atod() should be
94 * used. The format of the string must be as above. Then, the double 94 * used. The format of the string must be as above. Then, the double
95 * has the following mantiss and exponent: 95 * has the following mantissas and exponent:
96 * 96 *
97 * @code 97 * @code
98 * mantiss : [-]hhhhhh 98 * mantiss : [-]hhhhhh
99 * exponent : 2^([+-]e - 4 * n) 99 * exponent : 2^([+-]e - 4 * n)
100 * @endcode 100 * @endcode
101 * 101 *
102 * with n being number of cypers after the point in the string 102 * with n being number of cyphers after the point in the string
103 * format. To obtain the double number from the mantiss and exponent, 103 * format. To obtain the double number from the mantissas and exponent,
104 * use ldexp(). 104 * use ldexp().
105 * 105 *
106 * Here is an example of use: 106 * Here is an example of use:
@@ -163,31 +163,31 @@ EAPI extern Eina_Error EINA_ERROR_CONVERT_0X_NOT_FOUND; /**< Not used, perhaps a
163EAPI extern Eina_Error EINA_ERROR_CONVERT_OUTRUN_STRING_LENGTH; /**< Not used, perhaps a placeholder? Defined as 0 in eina_convert.c*/ 163EAPI extern Eina_Error EINA_ERROR_CONVERT_OUTRUN_STRING_LENGTH; /**< Not used, perhaps a placeholder? Defined as 0 in eina_convert.c*/
164 164
165/** 165/**
166 * @brief Convert an integer number to a string in decimal base. 166 * @brief Converts an integer number to a string in decimal base.
167 * 167 *
168 * @param n The integer to convert. 168 * @param n The integer to convert.
169 * @param s The buffer to store the converted integer. 169 * @param s The buffer to store the converted integer.
170 * @return The length of the string, including the nul terminated 170 * @return The length of the string, including the null terminated
171 * character. 171 * character.
172 * 172 *
173 * This function converts @p n to a nul terminated string. The 173 * This function converts @p n to a null terminated string. The
174 * converted string is in decimal base. As no check is done, @p s must 174 * converted string is in decimal base. As no check is done, @p s must
175 * be a buffer that is sufficiently large to store the integer. 175 * be a buffer that is sufficiently large to store the integer.
176 * 176 *
177 * The returned value is the length of the string, including the nul 177 * The returned value is the length of the string, including the null
178 * terminated character. 178 * terminated character.
179 */ 179 */
180EAPI int eina_convert_itoa(int n, char *s) EINA_ARG_NONNULL(2); 180EAPI int eina_convert_itoa(int n, char *s) EINA_ARG_NONNULL(2);
181 181
182/** 182/**
183 * @brief Convert an integer number to a string in hexadecimal base. 183 * @brief Converts an integer number to a string in hexadecimal base.
184 * 184 *
185 * @param n The integer to convert. 185 * @param n The integer to convert.
186 * @param s The buffer to store the converted integer. 186 * @param s The buffer to store the converted integer.
187 * @return The length of the string, including the nul terminated 187 * @return The length of the string, including the null terminated
188 * character. 188 * character.
189 * 189 *
190 * This function converts @p n to a nul terminated string. The 190 * This function converts @p n to a null terminated string. The
191 * converted string is in hexadecimal base and the alphabetical 191 * converted string is in hexadecimal base and the alphabetical
192 * cyphers are in lower case. As no check is done, @p s must be a 192 * cyphers are in lower case. As no check is done, @p s must be a
193 * buffer that is sufficiently large to store the integer. 193 * buffer that is sufficiently large to store the integer.
@@ -199,7 +199,7 @@ EAPI int eina_convert_xtoa(unsigned int n, char *s) EINA_ARG_NONNULL(2);
199 199
200 200
201/** 201/**
202 * @brief Convert a double to a string. 202 * @brief Converts a double to a string.
203 * 203 *
204 * @param d The double to convert. 204 * @param d The double to convert.
205 * @param des The destination buffer to store the converted double. 205 * @param des The destination buffer to store the converted double.
@@ -207,27 +207,27 @@ EAPI int eina_convert_xtoa(unsigned int n, char *s) EINA_ARG_NONNULL(2);
207 * 207 *
208 * This function converts the double @p d to a string. The string is 208 * This function converts the double @p d to a string. The string is
209 * stored in the buffer pointed by @p des and must be sufficiently 209 * stored in the buffer pointed by @p des and must be sufficiently
210 * large to contain the converted double. The returned string is nul 210 * large to contain the converted double. The returned string is null
211 * terminated and has the following format: 211 * terminated and has the following format:
212 * 212 *
213 * @code 213 * @code
214 * [-]0xh.hhhhhp[+-]e 214 * [-]0xh.hhhhhp[+-]e
215 * @endcode 215 * @endcode
216 * 216 *
217 * where the h are the hexadecimal cyphers of the mantiss and e the 217 * where the h are the hexadecimal cyphers of the mantissas and e the
218 * exponent (a decimal number). 218 * exponent (a decimal number).
219 * 219 *
220 * The returned value is the length of the string, including the nul 220 * The returned value is the length of the string, including the null
221 * character. 221 * character.
222 */ 222 */
223EAPI int eina_convert_dtoa(double d, char *des) EINA_ARG_NONNULL(2); 223EAPI int eina_convert_dtoa(double d, char *des) EINA_ARG_NONNULL(2);
224 224
225/** 225/**
226 * @brief Convert a string to a double. 226 * @brief Converts a string to a double.
227 * 227 *
228 * @param src The string to convert. 228 * @param src The string to convert.
229 * @param length The length of the string. 229 * @param length The length of the string.
230 * @param m The mantisse. 230 * @param m The mantissa.
231 * @param e The exponent. 231 * @param e The exponent.
232 * @return #EINA_TRUE on success, #EINA_FALSE otherwise. 232 * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
233 * 233 *
@@ -242,16 +242,16 @@ EAPI int eina_convert_dtoa(double d, char *des) EINA_ARG_NONNULL(2);
242 * [-]0xh.hhhhhp[+-]e 242 * [-]0xh.hhhhhp[+-]e
243 * @endcode 243 * @endcode
244 * 244 *
245 * where the h are the hexadecimal cyphers of the mantiss and e the 245 * where the h are the hexadecimal cyphers of the mantissas and e the
246 * exponent (a decimal number). If n is the number of cypers after the 246 * exponent (a decimal number). If n is the number of cyphers after the
247 * point, the returned mantiss and exponents are: 247 * point, the returned mantissas and exponents are:
248 * 248 *
249 * @code 249 * @code
250 * mantiss : [-]hhhhhh 250 * mantiss : [-]hhhhhh
251 * exponent : 2^([+-]e - 4 * n) 251 * exponent : 2^([+-]e - 4 * n)
252 * @endcode 252 * @endcode
253 * 253 *
254 * The mantiss and exponent are stored in the buffers pointed 254 * The mantissas and exponent are stored in the buffers pointed
255 * respectively by @p m and @p e. 255 * respectively by @p m and @p e.
256 * 256 *
257 * If the string is invalid #EINA_FALSE is returned, otherwise #EINA_TRUE is 257 * If the string is invalid #EINA_FALSE is returned, otherwise #EINA_TRUE is
@@ -264,7 +264,7 @@ EAPI Eina_Bool eina_convert_atod(const char *src,
264 264
265 265
266/** 266/**
267 * @brief Convert a 32.32 fixed point number to a string. 267 * @brief Converts a 32.32 fixed point number to a string.
268 * 268 *
269 * @param fp The fixed point number to convert. 269 * @param fp The fixed point number to convert.
270 * @param des The destination buffer to store the converted fixed point number. 270 * @param des The destination buffer to store the converted fixed point number.
@@ -280,10 +280,10 @@ EAPI Eina_Bool eina_convert_atod(const char *src,
280 * [-]0xh.hhhhhp[+-]e 280 * [-]0xh.hhhhhp[+-]e
281 * @endcode 281 * @endcode
282 * 282 *
283 * where the h are the hexadecimal cyphers of the mantiss and e the 283 * where the h are the hexadecimal cyphers of the mantissas and e the
284 * exponent (a decimal number). 284 * exponent (a decimal number).
285 * 285 *
286 * The returned value is the length of the string, including the nul 286 * The returned value is the length of the string, including the null
287 * character. 287 * character.
288 * 288 *
289 * @note The code is the same than eina_convert_dtoa() except that it 289 * @note The code is the same than eina_convert_dtoa() except that it
@@ -294,7 +294,7 @@ EAPI int eina_convert_fptoa(Eina_F32p32 fp,
294 char *des) EINA_ARG_NONNULL(2); 294 char *des) EINA_ARG_NONNULL(2);
295 295
296/** 296/**
297 * @brief Convert a string to a 32.32 fixed point number. 297 * @brief Converts a string to a 32.32 fixed point number.
298 * 298 *
299 * @param src The string to convert. 299 * @param src The string to convert.
300 * @param length The length of the string. 300 * @param length The length of the string.
@@ -312,16 +312,16 @@ EAPI int eina_convert_fptoa(Eina_F32p32 fp,
312 * [-]0xh.hhhhhp[+-]e 312 * [-]0xh.hhhhhp[+-]e
313 * @endcode 313 * @endcode
314 * 314 *
315 * where the h are the hexadecimal cyphers of the mantiss and e the 315 * where the h are the hexadecimal cyphers of the mantissas and e the
316 * exponent (a decimal number). If n is the number of cypers after the 316 * exponent (a decimal number). If n is the number of cyphers after the
317 * point, the returned mantiss and exponents are: 317 * point, the returned mantissas and exponents are:
318 * 318 *
319 * @code 319 * @code
320 * mantiss : [-]hhhhhh 320 * mantiss : [-]hhhhhh
321 * exponent : 2^([+-]e - 4 * n) 321 * exponent : 2^([+-]e - 4 * n)
322 * @endcode 322 * @endcode
323 * 323 *
324 * The mantiss and exponent are stored in the buffers pointed 324 * The mantissas and exponent are stored in the buffers pointed
325 * respectively by @p m and @p e. 325 * respectively by @p m and @p e.
326 * 326 *
327 * If the string is invalid, #EINA_FALSE is returned, 327 * If the string is invalid, #EINA_FALSE is returned,
diff --git a/src/lib/eina/eina_counter.h b/src/lib/eina/eina_counter.h
index 7c58ec1ec8..a4ad3395b6 100644
--- a/src/lib/eina/eina_counter.h
+++ b/src/lib/eina/eina_counter.h
@@ -114,14 +114,13 @@ typedef struct _Eina_Counter Eina_Counter;
114 114
115/** 115/**
116 * @brief Returns a counter. 116 * @brief Returns a counter.
117 *
118 * @param[in] name The name of the counter
119 * @return A newly allocated counter
120 *
121 * @details This function returns a new counter. It is characterized by @p 117 * @details This function returns a new counter. It is characterized by @p
122 * name. If @p name is @c NULL, the function returns @c NULL 118 * name. If @p name is @c NULL, the function returns @c NULL
123 * immediately. If memory allocation fails, @c NULL is returned. 119 * immediately. If memory allocation fails, @c NULL is returned.
124 * 120 *
121 * @param[in] name The name of the counter
122 * @return A newly allocated counter
123 *
125 * @note Whe the new counter is not needed anymore, use eina_counter_free() to 124 * @note Whe the new counter is not needed anymore, use eina_counter_free() to
126 * free the allocated memory. 125 * free the allocated memory.
127 */ 126 */
@@ -129,25 +128,23 @@ EAPI Eina_Counter *eina_counter_new(const char *name) EINA_WARN_UNUSED_RESULT EI
129 128
130/** 129/**
131 * @brief Deletes a counter. 130 * @brief Deletes a counter.
132 *
133 * @param[in] counter The counter to delete
134 *
135 * @details This function removes the clock of @p counter from the used clocks 131 * @details This function removes the clock of @p counter from the used clocks
136 * (see eina_counter_start()) and frees the memory allocated for 132 * (see eina_counter_start()) and frees the memory allocated for
137 * @p counter. If @p counter is @c NULL, the function returns 133 * @p counter. If @p counter is @c NULL, the function returns
138 * immediately. 134 * immediately.
135 * @param[in] counter The counter to delete
136 *
139 */ 137 */
140EAPI void eina_counter_free(Eina_Counter *counter) EINA_ARG_NONNULL(1); 138EAPI void eina_counter_free(Eina_Counter *counter) EINA_ARG_NONNULL(1);
141 139
142/** 140/**
143 * @brief Starts the time count. 141 * @brief Starts the time count.
144 *
145 * @param[in] counter The counter
146 *
147 * @details This function specifies that the part of the code beginning just 142 * @details This function specifies that the part of the code beginning just
148 * after its call is being timed, using @p counter. If 143 * after its call is being timed, using @p counter. If
149 * @p counter is @c NULL, this function returns immediately. 144 * @p counter is @c NULL, this function returns immediately.
150 * 145 *
146 * @param[in] counter The counter
147 *
151 * @note This function adds the clock associated to @p counter in a list. If 148 * @note This function adds the clock associated to @p counter in a list. If
152 * the memory needed by that clock can not be allocated, the function 149 * the memory needed by that clock can not be allocated, the function
153 * returns and nothing is done. 150 * returns and nothing is done.
@@ -159,30 +156,28 @@ EAPI void eina_counter_start(Eina_Counter *counter) EINA_ARG_NONNULL(1)
159 156
160/** 157/**
161 * @brief Stops the time count. 158 * @brief Stops the time count.
162 *
163 * @param[in] counter The counter
164 * @param[in] specimen The number of the test
165 *
166 * @details This function stops the timing that has been started with 159 * @details This function stops the timing that has been started with
167 * eina_counter_start(). @p counter must be the same as the one used 160 * eina_counter_start(). @p counter must be the same as the one used
168 * with eina_counter_start(). @p specimen is the number of the 161 * with eina_counter_start(). @p specimen is the number of the
169 * test. If @p counter or its associated clock is @c NULL, or if the 162 * test. If @p counter or its associated clock is @c NULL, or if the
170 * time can't be retrieved the function exits. 163 * time can't be retrieved the function exits.
164 * @param[in] counter The counter
165 * @param[in] specimen The number of the test
166 *
171 */ 167 */
172EAPI void eina_counter_stop(Eina_Counter *counter, 168EAPI void eina_counter_stop(Eina_Counter *counter,
173 int specimen) EINA_ARG_NONNULL(1); 169 int specimen) EINA_ARG_NONNULL(1);
174 170
175/** 171/**
176 * @brief Dumps the result of all the clocks of a counter to a stream. 172 * @brief Dumps the result of all the clocks of a counter to a stream.
177 *
178 * @param[in] counter The counter
179 * @return A string with a summary of the test
180 *
181 * @details This function returns an malloc'd string containing the dump of 173 * @details This function returns an malloc'd string containing the dump of
182 * all the valid clocks of @p counter. 174 * all the valid clocks of @p counter.
183 * If @p counter is @c NULL, the functions exits 175 * If @p counter is @c NULL, the functions exits
184 * immediately. Otherwise, the output is formatted like this: 176 * immediately. Otherwise, the output is formatted like this:
185 * 177 *
178 * @param[in] counter The counter
179 * @return A string with a summary of the test
180 *
186 * @verbatim 181 * @verbatim
187 * \# specimen experiment time starting time ending time 182 * \# specimen experiment time starting time ending time
188 * 1 208 120000 120208 183 * 1 208 120000 120208
diff --git a/src/lib/eina/eina_cow.h b/src/lib/eina/eina_cow.h
index 400cfe473f..c98c4b60f1 100644
--- a/src/lib/eina/eina_cow.h
+++ b/src/lib/eina/eina_cow.h
@@ -52,33 +52,33 @@ typedef struct _Eina_Cow Eina_Cow;
52typedef void Eina_Cow_Data; 52typedef void Eina_Cow_Data;
53 53
54/** 54/**
55 * @brief Instantiate a new Eina_Cow pool. 55 * @brief Instantiates a new Eina_Cow pool.
56 * 56 *
57 * @param name The name of this pool, used for debug. 57 * @param name The name of this pool, used for debug.
58 * @param struct_size The size of the object from this pool. 58 * @param struct_size The size of the object from this pool.
59 * @param step How many objects to allocate when the pool gets empty. 59 * @param step How many objects to allocate when the pool gets empty.
60 * @param default_value The default value returned by this pool. 60 * @param default_value The default value returned by this pool.
61 * @param gc Is it possible to run garbage collection on this pool. 61 * @param gc Is it possible to run garbage collection on this pool.
62 * @return a valid new Eina_Cow or @c NULL on error. 62 * @return A valid new Eina_Cow, or @c NULL on error.
63 */ 63 */
64EAPI Eina_Cow *eina_cow_add(const char *name, unsigned int struct_size, unsigned int step, const void *default_value, Eina_Bool gc) EINA_WARN_UNUSED_RESULT; 64EAPI Eina_Cow *eina_cow_add(const char *name, unsigned int struct_size, unsigned int step, const void *default_value, Eina_Bool gc) EINA_WARN_UNUSED_RESULT;
65 65
66/** 66/**
67 * @brief Destroy an Eina_Cow pool and all the allocated memory 67 * @brief Destroys an Eina_Cow pool and all the allocated memory.
68 * 68 *
69 * @param cow The pool to destroy 69 * @param cow The pool to destroy
70 */ 70 */
71EAPI void eina_cow_del(Eina_Cow *cow); 71EAPI void eina_cow_del(Eina_Cow *cow);
72 72
73/** 73/**
74 * @brief Return an initialized pointer from the pool. 74 * @brief Returns an initialized pointer from the pool.
75 * @param cow The pool to take things from. 75 * @param cow The pool to take things from.
76 * @return A pointer to the new pool instance 76 * @return A pointer to the new pool instance
77 */ 77 */
78EAPI const Eina_Cow_Data *eina_cow_alloc(Eina_Cow *cow) EINA_WARN_UNUSED_RESULT; 78EAPI const Eina_Cow_Data *eina_cow_alloc(Eina_Cow *cow) EINA_WARN_UNUSED_RESULT;
79 79
80/** 80/**
81 * @brief Free a pointer from the pool. 81 * @brief Frees a pointer from the pool.
82 * @param cow The pool to gave back memory to. 82 * @param cow The pool to gave back memory to.
83 * @param data The data to give back. 83 * @param data The data to give back.
84 * 84 *
@@ -88,7 +88,7 @@ EAPI const Eina_Cow_Data *eina_cow_alloc(Eina_Cow *cow) EINA_WARN_UNUSED_RESULT;
88EAPI void eina_cow_free(Eina_Cow *cow, const Eina_Cow_Data **data); 88EAPI void eina_cow_free(Eina_Cow *cow, const Eina_Cow_Data **data);
89 89
90/** 90/**
91 * @brief Get a writable pointer from a const pointer. 91 * @brief Gets a writeable pointer from a const pointer.
92 * @param cow The pool the pointer come from. 92 * @param cow The pool the pointer come from.
93 * @param src The pointer you want to write to. 93 * @param src The pointer you want to write to.
94 * 94 *
@@ -97,7 +97,7 @@ EAPI void eina_cow_free(Eina_Cow *cow, const Eina_Cow_Data **data);
97EAPI void *eina_cow_write(Eina_Cow *cow, 97EAPI void *eina_cow_write(Eina_Cow *cow,
98 const Eina_Cow_Data * const *src) EINA_WARN_UNUSED_RESULT; 98 const Eina_Cow_Data * const *src) EINA_WARN_UNUSED_RESULT;
99/** 99/**
100 * @brief Set back a pointer into read only. 100 * @brief Sets back a pointer into read only.
101 * @param cow The pool the pointer come from. 101 * @param cow The pool the pointer come from.
102 * @param dst The read only version of the pointer. 102 * @param dst The read only version of the pointer.
103 * @param data The pointer to which data was written to. 103 * @param data The pointer to which data was written to.
@@ -110,7 +110,7 @@ EAPI void eina_cow_done(Eina_Cow *cow,
110 const void *data, 110 const void *data,
111 Eina_Bool needed_gc); 111 Eina_Bool needed_gc);
112/** 112/**
113 * @brief Make the destination contain the same thing as the source pointer. 113 * @brief Makes the destination contain the same thing as the source pointer.
114 * @param cow The pool the pointers come from. 114 * @param cow The pool the pointers come from.
115 * @param dst The destination to update. 115 * @param dst The destination to update.
116 * @param src The source of information to copy. 116 * @param src The source of information to copy.
@@ -120,7 +120,7 @@ EAPI void eina_cow_memcpy(Eina_Cow *cow,
120 const Eina_Cow_Data *src); 120 const Eina_Cow_Data *src);
121 121
122/** 122/**
123 * @brief Try to find entries that have the same content and update them. 123 * @brief Tries to find entries that have the same content and update them.
124 * @param cow The cow to try to compact. 124 * @param cow The cow to try to compact.
125 * @return EINA_TRUE if something was compacted, EINA_FALSE if nothing was. 125 * @return EINA_TRUE if something was compacted, EINA_FALSE if nothing was.
126 * 126 *
@@ -132,7 +132,7 @@ EAPI Eina_Bool eina_cow_gc(Eina_Cow *cow);
132 132
133/** 133/**
134 * @def EINA_COW_WRITE_BEGIN 134 * @def EINA_COW_WRITE_BEGIN
135 * @brief This macro setup a writable pointer from a const one. 135 * @brief Definition for the macro to setup a writeable pointer from a const one.
136 * @param Cow The Eina_Cow where the const pointer come from. 136 * @param Cow The Eina_Cow where the const pointer come from.
137 * @param Read The const pointer to get a writable handler from. 137 * @param Read The const pointer to get a writable handler from.
138 * @param Write_Type The type of the pointer you want to write to. 138 * @param Write_Type The type of the pointer you want to write to.
@@ -151,7 +151,7 @@ EAPI Eina_Bool eina_cow_gc(Eina_Cow *cow);
151 151
152/** 152/**
153 * @def EINA_COW_WRITE_END 153 * @def EINA_COW_WRITE_END
154 * @brief This macro close the writable pointer. 154 * @brief Definition for the macro to close the writeable pointer.
155 * @param Cow The Eina_Cow where the const pointer come from. 155 * @param Cow The Eina_Cow where the const pointer come from.
156 * @param Read The const pointer to get a writable handler from. 156 * @param Read The const pointer to get a writable handler from.
157 * @param Write The name of the variable where to put the writeable pointer to. 157 * @param Write The name of the variable where to put the writeable pointer to.
diff --git a/src/lib/eina/eina_cpu.h b/src/lib/eina/eina_cpu.h
index e97d61417e..05de0fa8f5 100644
--- a/src/lib/eina/eina_cpu.h
+++ b/src/lib/eina/eina_cpu.h
@@ -59,31 +59,31 @@ typedef enum _Eina_Cpu_Features
59} Eina_Cpu_Features; 59} Eina_Cpu_Features;
60 60
61/** 61/**
62 * @brief Global hardware architecture handler 62 * @brief Global hardware architecture handler.
63 * 63 *
64 * @return the current cpu features 64 * @return the current cpu features
65 */ 65 */
66EAPI extern Eina_Cpu_Features eina_cpu_features; 66EAPI extern Eina_Cpu_Features eina_cpu_features;
67 67
68/** 68/**
69 * @brief Cpu features accessor 69 * @brief Cpu features accessor.
70 * 70 *
71 * @return the current cpu features 71 * @return the current cpu features
72 */ 72 */
73EAPI Eina_Cpu_Features eina_cpu_features_get(void); 73EAPI Eina_Cpu_Features eina_cpu_features_get(void);
74 74
75/** 75/**
76 * @brief Get the current number of processors 76 * @brief Gets the current number of processors.
77 * 77 *
78 * @return the number of processors that are online, that 78 * @return The number of processors that are online, that
79 * is available when the function is called. 79 * is available when the function is called.
80 */ 80 */
81EAPI int eina_cpu_count(void); 81EAPI int eina_cpu_count(void);
82 82
83/** 83/**
84 * @brief Get the current virtual page size 84 * @brief Gets the current virtual page size.
85 * 85 *
86 * @return the fixed length that represents the smallest unit of data for memory 86 * @return The fixed length that represents the smallest unit of data for memory
87 * allocation performed by the operating system on behalf of the program, and 87 * allocation performed by the operating system on behalf of the program, and
88 * for transfers between the main memory and any other auxiliary store. 88 * for transfers between the main memory and any other auxiliary store.
89 */ 89 */
@@ -93,7 +93,7 @@ EAPI int eina_cpu_page_size(void);
93 * @brief Reverses the byte order of a 16-bit (destination) register. 93 * @brief Reverses the byte order of a 16-bit (destination) register.
94 * 94 *
95 * @param x The binary word to swap 95 * @param x The binary word to swap
96 * @return a byte order swapped 16-bit integer. 96 * @return A byte order swapped 16-bit integer.
97 * 97 *
98 * On big endian systems, the number is converted to little endian byte order. 98 * On big endian systems, the number is converted to little endian byte order.
99 * On little endian systems, the number is converted to big endian byte order. 99 * On little endian systems, the number is converted to big endian byte order.
@@ -104,7 +104,7 @@ static inline unsigned short eina_swap16(unsigned short x);
104 * @brief Reverses the byte order of a 32-bit (destination) register. 104 * @brief Reverses the byte order of a 32-bit (destination) register.
105 * 105 *
106 * @param x The binary word to swap 106 * @param x The binary word to swap
107 * @return a byte order swapped 32-bit integer. 107 * @return A byte order swapped 32-bit integer.
108 * 108 *
109 * On big endian systems, the number is converted to little endian byte order. 109 * On big endian systems, the number is converted to little endian byte order.
110 * On little endian systems, the number is converted to big endian byte order. 110 * On little endian systems, the number is converted to big endian byte order.
@@ -115,7 +115,7 @@ static inline unsigned int eina_swap32(unsigned int x);
115 * @brief Reverses the byte order of a 64-bit (destination) register. 115 * @brief Reverses the byte order of a 64-bit (destination) register.
116 * 116 *
117 * @param x The binary word to swap 117 * @param x The binary word to swap
118 * @return a byte order swapped 64-bit integer. 118 * @return A byte order swapped 64-bit integer.
119 * 119 *
120 * On big endian systems, the number is converted to little endian byte order. 120 * On big endian systems, the number is converted to little endian byte order.
121 * On little endian systems, the number is converted to big endian byte order. 121 * On little endian systems, the number is converted to big endian byte order.
diff --git a/src/lib/eina/eina_crc.h b/src/lib/eina/eina_crc.h
index 819ca911dd..fe1a919898 100644
--- a/src/lib/eina/eina_crc.h
+++ b/src/lib/eina/eina_crc.h
@@ -12,7 +12,7 @@
12#include "eina_magic.h" 12#include "eina_magic.h"
13 13
14/** 14/**
15 * @brief Generate a crc checksum for the given data using crc-32 algorithm. 15 * @brief Generates a crc checksum for the given data using crc-32 algorithm.
16 * 16 *
17 * @param key The data for which crc checksum has to be generated. 17 * @param key The data for which crc checksum has to be generated.
18 * @param len The length of the data. 18 * @param len The length of the data.
diff --git a/src/lib/eina/eina_error.h b/src/lib/eina/eina_error.h
index 71df4848db..80d243b165 100644
--- a/src/lib/eina/eina_error.h
+++ b/src/lib/eina/eina_error.h
@@ -107,16 +107,15 @@ EAPI extern Eina_Error EINA_ERROR_OUT_OF_MEMORY EINA_DEPRECATED; /* use ENOMEM *
107 107
108/** 108/**
109 * @brief Registers a new error type. 109 * @brief Registers a new error type.
110 *
111 * @param[in] msg The description of the error \n
112 * It is duplicated using eina_stringshare_add().
113 * @return The unique number identifier for this error
114 *
115 * @details This function stores the error message described by 110 * @details This function stores the error message described by
116 * @p msg in a list. The returned value is a unique identifier greater than or equal 111 * @p msg in a list. The returned value is a unique identifier greater than or equal
117 * to @c 1. The description can be retrieved later by passing 112 * to @c 1. The description can be retrieved later by passing
118 * the returned value to eina_error_msg_get(). 113 * the returned value to eina_error_msg_get().
119 * 114 *
115 * @param[in] msg The description of the error \n
116 * It is duplicated using eina_stringshare_add().
117 * @return The unique number identifier for this error
118 *
120 * @note There is no need to register messages that exist in libC's @c 119 * @note There is no need to register messages that exist in libC's @c
121 * errno.h, such as @c ENOMEM or @c EBADF. 120 * errno.h, such as @c ENOMEM or @c EBADF.
122 * 121 *
@@ -126,17 +125,16 @@ EAPI Eina_Error eina_error_msg_register(const char *msg) EINA_ARG_NONNULL(1) EI
126 125
127/** 126/**
128 * @brief Registers a new error type, statically allocated message. 127 * @brief Registers a new error type, statically allocated message.
128 * @details This function stores the error message described by
129 * @p msg in a list. The returned value is a unique identifier greater than or equal
130 * to @c 1. The description can be retrieved later by passing
131 * the returned value to eina_error_msg_get().
129 * 132 *
130 * @param[in] msg The description of the error \n 133 * @param[in] msg The description of the error \n
131 * This string is not duplicated and thus 134 * This string is not duplicated and thus
132 * the given pointer should live during the usage of eina_error. 135 * the given pointer should live during the usage of eina_error.
133 * @return The unique number identifier for this error 136 * @return The unique number identifier for this error
134 * 137 *
135 * @details This function stores the error message described by
136 * @p msg in a list. The returned value is a unique identifier greater than or equal
137 * to @c 1. The description can be retrieved later by passing
138 * the returned value to eina_error_msg_get().
139 *
140 * @note There is no need to register messages that exist in libC's @c 138 * @note There is no need to register messages that exist in libC's @c
141 * errno.h, such as @c ENOMEM or @c EBADF. 139 * errno.h, such as @c ENOMEM or @c EBADF.
142 * 140 *
@@ -146,6 +144,10 @@ EAPI Eina_Error eina_error_msg_static_register(const char *msg) EINA_ARG_NONNUL
146 144
147/** 145/**
148 * @brief Changes the message of an already registered message. 146 * @brief Changes the message of an already registered message.
147 * @details This function modifies the message associated with @p error and changes
148 * it to @p msg. If the error is previously registered by @ref eina_error_msg_static_register
149 * then the string is not duplicated, otherwise the previous message
150 * is unrefed and @p msg is copied.
149 * 151 *
150 * @param[in] error The Eina_Error to change the message of 152 * @param[in] error The Eina_Error to change the message of
151 * @param[in] msg The description of the error \n 153 * @param[in] msg The description of the error \n
@@ -153,11 +155,6 @@ EAPI Eina_Error eina_error_msg_static_register(const char *msg) EINA_ARG_NONNUL
153 * otherwise it must remain intact for the duration. 155 * otherwise it must remain intact for the duration.
154 * @return #EINA_TRUE if successful, otherwise #EINA_FALSE on error 156 * @return #EINA_TRUE if successful, otherwise #EINA_FALSE on error
155 * 157 *
156 * @details This function modifies the message associated with @p error and changes
157 * it to @p msg. If the error is previously registered by @ref eina_error_msg_static_register
158 * then the string is not duplicated, otherwise the previous message
159 * is unrefed and @p msg is copied.
160 *
161 * @note It is not possible to modify messages that exist in libC's @c 158 * @note It is not possible to modify messages that exist in libC's @c
162 * errno.h, such as @c ENOMEM or @c EBADF. 159 * errno.h, such as @c ENOMEM or @c EBADF.
163 * 160 *
@@ -169,24 +166,22 @@ EAPI Eina_Bool eina_error_msg_modify(Eina_Error error,
169 166
170/** 167/**
171 * @brief Returns the last set error. 168 * @brief Returns the last set error.
172 *
173 * @return The last error or 0 (#EINA_ERROR_NO_ERROR).
174 *
175 * @details This function returns the last error set by eina_error_set(). The 169 * @details This function returns the last error set by eina_error_set(). The
176 * description of the message is returned by eina_error_msg_get(). 170 * description of the message is returned by eina_error_msg_get().
177 * 171 *
172 * @return The last error or 0 (#EINA_ERROR_NO_ERROR).
173 *
178 * @note This function is thread safe @since 1.10, but slower to use. 174 * @note This function is thread safe @since 1.10, but slower to use.
179 */ 175 */
180EAPI Eina_Error eina_error_get(void); 176EAPI Eina_Error eina_error_get(void);
181 177
182/** 178/**
183 * @brief Sets the last error. 179 * @brief Sets the last error.
184 *
185 * @param[in] err The error identifier
186 *
187 * @details This function sets the last error identifier. The last error can be 180 * @details This function sets the last error identifier. The last error can be
188 * retrieved by eina_error_get(). 181 * retrieved by eina_error_get().
189 * 182 *
183 * @param[in] err The error identifier
184 *
190 * @note This is also used to clear previous errors, in which case @p err should 185 * @note This is also used to clear previous errors, in which case @p err should
191 * be @c 0 (#EINA_ERROR_NO_ERROR). 186 * be @c 0 (#EINA_ERROR_NO_ERROR).
192 * 187 *
@@ -196,25 +191,23 @@ EAPI void eina_error_set(Eina_Error err);
196 191
197/** 192/**
198 * @brief Returns the description of the given error number. 193 * @brief Returns the description of the given error number.
199 *
200 * @param[in] error The error number
201 * @return The description of the error
202 *
203 * @details This function returns the description of an error that has been 194 * @details This function returns the description of an error that has been
204 * registered by eina_error_msg_register(). If an incorrect error is 195 * registered by eina_error_msg_register(). If an incorrect error is
205 * given, then @c NULL is returned. 196 * given, then @c NULL is returned.
197 * @param[in] error The error number
198 * @return The description of the error
199 *
206 */ 200 */
207EAPI const char *eina_error_msg_get(Eina_Error error) EINA_PURE; 201EAPI const char *eina_error_msg_get(Eina_Error error) EINA_PURE;
208 202
209/** 203/**
210 * @brief Finds the #Eina_Error corresponding to a message string. 204 * @brief Finds the #Eina_Error corresponding to a message string.
205 * @details This function attempts to match @p msg with its corresponding #Eina_Error value.
206 * If no such value is found, @c 0 is returned.
211 * 207 *
212 * @param[in] msg The error message string to match (NOT @c NULL) 208 * @param[in] msg The error message string to match (NOT @c NULL)
213 * @return The #Eina_Error matching @p msg, otherwise @c 0 on failure 209 * @return The #Eina_Error matching @p msg, otherwise @c 0 on failure
214 * 210 *
215 * @details This function attempts to match @p msg with its corresponding #Eina_Error value.
216 * If no such value is found, @c 0 is returned.
217 *
218 * @note this function only works for explicitly registered errors 211 * @note this function only works for explicitly registered errors
219 * such as the messages given to eina_error_msg_register(), 212 * such as the messages given to eina_error_msg_register(),
220 * eina_error_msg_static_register() or modified with 213 * eina_error_msg_static_register() or modified with
diff --git a/src/lib/eina/eina_evlog.h b/src/lib/eina/eina_evlog.h
index 97278636dc..65f7908651 100644
--- a/src/lib/eina/eina_evlog.h
+++ b/src/lib/eina/eina_evlog.h
@@ -56,7 +56,7 @@ struct _Eina_Evlog_Buf
56}; 56};
57 57
58/** 58/**
59 * @brief Log an event in our event log for profiling data 59 * @brief Logs an event in our event log for profiling data.
60 * 60 *
61 * Log some interesting event inside of EFL, eg a wakeup (and why etc.). 61 * Log some interesting event inside of EFL, eg a wakeup (and why etc.).
62 * The @p event string must alwasy be provided and be of the form: 62 * The @p event string must alwasy be provided and be of the form:
@@ -117,7 +117,7 @@ EAPI void
117eina_evlog(const char *event, void *obj, double srctime, const char *detail); 117eina_evlog(const char *event, void *obj, double srctime, const char *detail);
118 118
119/** 119/**
120 * @brief Steal an event log buffer from the evlog core 120 * @brief Steals an event log buffer from the evlog core.
121 * 121 *
122 * Only one buffer can be stolen at any time. If you steal a new buffer, the 122 * Only one buffer can be stolen at any time. If you steal a new buffer, the
123 * old stolen buffer is "released" back to the evlog core. 123 * old stolen buffer is "released" back to the evlog core.
@@ -130,7 +130,7 @@ EAPI Eina_Evlog_Buf *
130eina_evlog_steal(void); 130eina_evlog_steal(void);
131 131
132/** 132/**
133 * @brief Begin logging - until now eina_evlog is a NOOP 133 * @brief Begins logging - until now eina_evlog is a NOOP.
134 * 134 *
135 * @since 1.15 135 * @since 1.15
136 */ 136 */
@@ -138,7 +138,7 @@ EAPI void
138eina_evlog_start(void); 138eina_evlog_start(void);
139 139
140/** 140/**
141 * @brief Stop logging 141 * @brief Stops logging.
142 * 142 *
143 * You must not be using any evlog buffers stolen by eina_evlog_steal() by 143 * You must not be using any evlog buffers stolen by eina_evlog_steal() by
144 * the time you call this function. 144 * the time you call this function.
diff --git a/src/lib/eina/eina_file.h b/src/lib/eina/eina_file.h
index 7a1c55994f..e5098be065 100644
--- a/src/lib/eina/eina_file.h
+++ b/src/lib/eina/eina_file.h
@@ -71,7 +71,7 @@
71 * @brief This group discusses the functions to handle files and directories. 71 * @brief This group discusses the functions to handle files and directories.
72 * 72 *
73 * @details These functions make it easier to do a number of file and directory operations 73 * @details These functions make it easier to do a number of file and directory operations
74 * such as getting the list of files in a directory, spliting paths, and finding 74 * such as getting the list of files in a directory, splitting paths, and finding
75 * out file size and type. 75 * out file size and type.
76 * 76 *
77 * @warning All functions in this group are @b blocking, which means they may 77 * @warning All functions in this group are @b blocking, which means they may
@@ -159,7 +159,7 @@ typedef enum {
159 * it never happens */ 159 * it never happens */
160/** 160/**
161 * @def EINA_PATH_MAX 161 * @def EINA_PATH_MAX
162 * @brief The constant defined as the highest value for PATH_MAX. 162 * @brief Definition for the constant defined as the highest value for PATH_MAX.
163 */ 163 */
164#define EINA_PATH_MAX 8192 164#define EINA_PATH_MAX 8192
165 165
@@ -239,23 +239,15 @@ struct _Eina_File_Line
239/** 239/**
240 * @def EINA_FILE_DIR_LIST_CB 240 * @def EINA_FILE_DIR_LIST_CB
241 * @brief The macro to cast to an #Eina_File_Dir_List_Cb. 241 * @brief The macro to cast to an #Eina_File_Dir_List_Cb.
242 * 242 * @details This macro casts @p function to #Eina_File_Dir_List_Cb.
243 * @param function The function to cast 243 * @param function The function to cast
244 * 244 *
245 * @details This macro casts @p function to #Eina_File_Dir_List_Cb.
246 */ 245 */
247#define EINA_FILE_DIR_LIST_CB(function) ((Eina_File_Dir_List_Cb)function) 246#define EINA_FILE_DIR_LIST_CB(function) ((Eina_File_Dir_List_Cb)function)
248 247
249 248
250/** 249/**
251 * @brief Lists all the files on the directory by calling the function for every file found. 250 * @brief Lists all the files on the directory by calling the function for every file found.
252 *
253 * @param[in] dir The directory name
254 * @param[in] recursive Iterate recursively in the directory
255 * @param[in] cb The callback to be called
256 * @param[in] data The data to pass to the callback
257 * @return #EINA_TRUE on success, otherwise #EINA_FALSE
258 *
259 * @details This function calls @p cb for each file that is in @p dir. To have @p cb 251 * @details This function calls @p cb for each file that is in @p dir. To have @p cb
260 * called on the files that are in subdirectories of @p dir, @p recursive should 252 * called on the files that are in subdirectories of @p dir, @p recursive should
261 * be #EINA_TRUE. In other words, if @p recursive is #EINA_FALSE, only direct children 253 * be #EINA_TRUE. In other words, if @p recursive is #EINA_FALSE, only direct children
@@ -265,6 +257,12 @@ struct _Eina_File_Line
265 * If @p cb or @p dir is @c NULL or if @p dir is a string of size 0, 257 * If @p cb or @p dir is @c NULL or if @p dir is a string of size 0,
266 * or if @p dir cannot be opened, this function returns #EINA_FALSE 258 * or if @p dir cannot be opened, this function returns #EINA_FALSE
267 * immediately. Otherwise, it returns #EINA_TRUE. 259 * immediately. Otherwise, it returns #EINA_TRUE.
260 *
261 * @param[in] dir The directory name
262 * @param[in] recursive Iterate recursively in the directory
263 * @param[in] cb The callback to be called
264 * @param[in] data The data to pass to the callback
265 * @return #EINA_TRUE on success, otherwise #EINA_FALSE
268 */ 266 */
269EAPI Eina_Bool eina_file_dir_list(const char *dir, 267EAPI Eina_Bool eina_file_dir_list(const char *dir,
270 Eina_Bool recursive, 268 Eina_Bool recursive,
@@ -273,28 +271,27 @@ EAPI Eina_Bool eina_file_dir_list(const char *dir,
273 271
274/** 272/**
275 * @brief Splits a path according to the delimiter of the filesystem. 273 * @brief Splits a path according to the delimiter of the filesystem.
276 *
277 * @param[in] path The path to split
278 * @return An array of the parts of the path to split
279 *
280 * @details This function splits @p path according to the delimiter of the used 274 * @details This function splits @p path according to the delimiter of the used
281 * filesystem. If @p path is @c NULL or if the array cannot be 275 * filesystem. If @p path is @c NULL or if the array cannot be
282 * created, @c NULL is returned, otherwise an array with each part of @p path 276 * created, @c NULL is returned, otherwise an array with each part of @p path
283 * is returned. 277 * is returned.
278 *
279 * @param[in] path The path to split
280 * @return An array of the parts of the path to split
281 *
284 */ 282 */
285EAPI Eina_Array *eina_file_split(char *path) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC; 283EAPI Eina_Array *eina_file_split(char *path) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC;
286 284
287/** 285/**
288 * @brief Gets an iterator to list the content of a directory. 286 * @brief Gets an iterator to list the content of a directory.
287 * @details This returns an iterator for shared strings, the name of each file in @p dir is
288 * only fetched when advancing the iterator, which means there is very little
289 * cost associated with creating the list and stopping halfway through it.
289 * 290 *
290 * @param [in] dir The name of the directory to list 291 * @param [in] dir The name of the directory to list
291 * @return An #Eina_Iterator that walks over the files and directories 292 * @return An #Eina_Iterator that walks over the files and directories
292 * in @p dir. On failure, it returns @c NULL. 293 * in @p dir. On failure, it returns @c NULL.
293 * 294 *
294 * @details This returns an iterator for shared strings, the name of each file in @p dir is
295 * only fetched when advancing the iterator, which means there is very little
296 * cost associated with creating the list and stopping halfway through it.
297 *
298 * @note The iterator hands the user a stringshared value with the full 295 * @note The iterator hands the user a stringshared value with the full
299 * path. The user must free the string using eina_stringshare_del() on it. 296 * path. The user must free the string using eina_stringshare_del() on it.
300 * 297 *
@@ -308,16 +305,15 @@ EAPI Eina_Iterator *eina_file_ls(const char *dir) EINA_WARN_UNUSED_RESULT EINA_A
308/** 305/**
309 * @brief Gets an iterator to list the content of a directory, with direct 306 * @brief Gets an iterator to list the content of a directory, with direct
310 * information. 307 * information.
308 * @details This returns an iterator for #Eina_File_Direct_Info, the name of each file in @p
309 * dir is only fetched when advancing the iterator, which means there is
310 * cost associated with creating the list and stopping halfway through it.
311 * 311 *
312 * @param [in] dir The name of the directory to list 312 * @param [in] dir The name of the directory to list
313 * 313 *
314 * @return An #Eina_Iterator that walks over the files and 314 * @return An #Eina_Iterator that walks over the files and
315 * directories in @p dir. On failure, it returns @c NULL. 315 * directories in @p dir. On failure, it returns @c NULL.
316 * 316 *
317 * @details This returns an iterator for #Eina_File_Direct_Info, the name of each file in @p
318 * dir is only fetched when advancing the iterator, which means there is
319 * cost associated with creating the list and stopping halfway through it.
320 *
321 * @warning The #Eina_File_Direct_Info returned by the iterator <b>must not</b> 317 * @warning The #Eina_File_Direct_Info returned by the iterator <b>must not</b>
322 * be modified in any way. 318 * be modified in any way.
323 * @warning When the iterator is advanced or deleted the #Eina_File_Direct_Info 319 * @warning When the iterator is advanced or deleted the #Eina_File_Direct_Info
@@ -336,14 +332,13 @@ EAPI Eina_Iterator *eina_file_stat_ls(const char *dir) EINA_WARN_UNUSED_RESULT E
336/** 332/**
337 * @brief Uses information provided by #Eina_Iterator of eina_file_stat_ls() or eina_file_direct_ls() 333 * @brief Uses information provided by #Eina_Iterator of eina_file_stat_ls() or eina_file_direct_ls()
338 * to call stat in the most efficient way on your system. 334 * to call stat in the most efficient way on your system.
335 * @details This function calls fstatat or stat depending on what your system supports. This makes it efficient and simple
336 * to use on your side without complex detection already done inside Eina on what the system can do.
339 * 337 *
340 * @param[in] container The container returned by #Eina_Iterator using eina_iterator_container_get() 338 * @param[in] container The container returned by #Eina_Iterator using eina_iterator_container_get()
341 * @param[in] info The content of the current #Eina_File_Direct_Info provided by #Eina_Iterator 339 * @param[in] info The content of the current #Eina_File_Direct_Info provided by #Eina_Iterator
342 * @param[in] buf The location put the result of the stat 340 * @param[in] buf The location put the result of the stat
343 * @return @c 0 is returnedon success, otherwise @c -1 is returned on error and errno is set appropriately 341 * @return @c 0 is returned on success, otherwise @c -1 is returned on error and errno is set appropriately
344 *
345 * @details This function calls fstatat or stat depending on what your system supports. This makes it efficient and simple
346 * to use on your side without complex detection already done inside Eina on what the system can do.
347 * 342 *
348 * @see eina_file_direct_ls() 343 * @see eina_file_direct_ls()
349 * @see eina_file_stat_ls() 344 * @see eina_file_stat_ls()
@@ -355,19 +350,18 @@ EAPI int eina_file_statat(void *container, Eina_File_Direct_Info *info, Eina_Sta
355/** 350/**
356 * @brief Generates and creates a uniquely named temporary file from a template name. 351 * @brief Generates and creates a uniquely named temporary file from a template name.
357 * The generated file is opened with the open(2) @c O_EXCL flag. 352 * The generated file is opened with the open(2) @c O_EXCL flag.
353 * @details This function calls mkstemp(), generates a unique temporary filename
354 * from template, creates and opens the file, and returns an open file
355 * descriptor for the file.
358 * 356 *
359 * @param[in] templatename This is a string. It must contain the six characters 'XXXXXX' 357 * @param[in] templatename This is a string. It must contain the six characters 'XXXXXX'
360 * at the end or directly followed by an extension as in 358 * at the end or directly followed by an extension as in
361 * 'prefixXXXXXX.ext'. 359 * 'prefixXXXXXX.ext'.
362 * @param[out] path The path to the created temporary file, or @c NULL in case of failure. 360 * @param[out] path The path to the created temporary file, or @c NULL in case of failure.
363 * It must be released by eina_tmpstr_del(). 361 * It must be released by eina_tmpstr_del().
364 * @return On success @c file descriptor of the temporary file is returned, 362 * @return On success @c file descriptor of the temporary file is returned,
365 * On error @c -1 is returned, in which case @c errno is set appropriately. 363 * On error @c -1 is returned, in which case @c errno is set appropriately.
366 * 364 *
367 * @details This function calls mkstemp(), generates a unique temporary filename
368 * from template, creates and opens the file, and returns an open file
369 * descriptor for the file.
370 *
371 * @note If a filename extension was specified in @p templatename, then the new @p path 365 * @note If a filename extension was specified in @p templatename, then the new @p path
372 * will also contain this extension (since 1.10). 366 * will also contain this extension (since 1.10).
373 * 367 *
@@ -376,7 +370,7 @@ EAPI int eina_file_statat(void *container, Eina_File_Direct_Info *info, Eina_Sta
376 * the system temporary directory (@see eina_environment_tmp_get()). If the 370 * the system temporary directory (@see eina_environment_tmp_get()). If the
377 * @p templatename contains a directory separator ('/', or '\\' on Windows) 371 * @p templatename contains a directory separator ('/', or '\\' on Windows)
378 * then the file will be created inside this directory, which must exist and 372 * then the file will be created inside this directory, which must exist and
379 * be writable. Use ./filename.XXXXXX to create files in the current 373 * be writeable. Use ./filename.XXXXXX to create files in the current
380 * working directory. (since 1.17) 374 * working directory. (since 1.17)
381 * 375 *
382 * @see eina_file_mkdtemp() 376 * @see eina_file_mkdtemp()
@@ -386,23 +380,22 @@ EAPI int eina_file_mkstemp(const char *templatename, Eina_Tmpstr **path) EINA_AR
386 380
387/** 381/**
388 * @brief Generates and creates a uniquely named temporary directory from a template name. 382 * @brief Generates and creates a uniquely named temporary directory from a template name.
383 * @details This function calls mkdtemp(). The directory is then created with
384 * permissions 0700.
389 * 385 *
390 * @param[in] templatename This is a string. The last six characters of @p templatename 386 * @param[in] templatename This is a string. The last six characters of @p templatename
391 * must be XXXXXX. 387 * must be XXXXXX.
392 * @param[out] path The path to the created temporary directory, or @c NULL in case of failure. 388 * @param[out] path The path to the created temporary directory, or @c NULL in case of failure.
393 * It must be released by eina_tmpstr_del(). 389 * It must be released by eina_tmpstr_del().
394 * @return On success @c EINA_TRUE is returned, On error @c EINA_FALSE is returned, 390 * @return On success @c EINA_TRUE is returned, On error @c EINA_FALSE is returned,
395 * in which case @c errno is set appropriately. 391 * in which case @c errno is set appropriately.
396 * 392 *
397 * @details This function calls mkdtemp(). The directory is then created with
398 * permissions 0700.
399 *
400 * @note If the @p templatename is a simple directory name (no relative or absolute 393 * @note If the @p templatename is a simple directory name (no relative or absolute
401 * path to another directory), then a temporary directory will be created inside 394 * path to another directory), then a temporary directory will be created inside
402 * the system temporary directory (@see eina_environment_tmp_get()). If the 395 * the system temporary directory (@see eina_environment_tmp_get()). If the
403 * @p templatename contains a directory separator ('/', or '\\' on Windows) 396 * @p templatename contains a directory separator ('/', or '\\' on Windows)
404 * then the temporary directory will be created inside that other directory, 397 * then the temporary directory will be created inside that other directory,
405 * which must exist and be writable. (since 1.17) 398 * which must exist and be writeable. (since 1.17)
406 * 399 *
407 * @see eina_file_mkstemp() 400 * @see eina_file_mkstemp()
408 * @since 1.8 401 * @since 1.8
@@ -412,16 +405,15 @@ EAPI Eina_Bool eina_file_mkdtemp(const char *templatename, Eina_Tmpstr **path) E
412/** 405/**
413 * @brief Gets an iterator to list the content of a directory, with direct 406 * @brief Gets an iterator to list the content of a directory, with direct
414 * information. 407 * information.
408 * @details This returns an iterator for #Eina_File_Direct_Info, the name of each file in
409 * @p dir is only fetched when advancing the iterator, which means there is
410 * cost associated with creating the list and stopping halfway through it.
415 * 411 *
416 * @param [in] dir The name of the directory to list 412 * @param [in] dir The name of the directory to list
417 * 413 *
418 * @return An Eina_Iterator that walks over the files and 414 * @return An Eina_Iterator that walks over the files and
419 * directories in @p dir. On failure, it returns @c NULL. 415 * directories in @p dir. On failure, it returns @c NULL.
420 * 416 *
421 * @details This returns an iterator for #Eina_File_Direct_Info, the name of each file in
422 * @p dir is only fetched when advancing the iterator, which means there is
423 * cost associated with creating the list and stopping halfway through it.
424 *
425 * @warning If readdir_r doesn't contain file type information, file type is 417 * @warning If readdir_r doesn't contain file type information, file type is
426 * EINA_FILE_UNKNOWN. 418 * EINA_FILE_UNKNOWN.
427 * @warning The #Eina_File_Direct_Info returned by the iterator <b>must not</b> 419 * @warning The #Eina_File_Direct_Info returned by the iterator <b>must not</b>
@@ -441,15 +433,14 @@ EAPI Eina_Iterator *eina_file_direct_ls(const char *dir) EINA_WARN_UNUSED_RESULT
441 433
442/** 434/**
443 * @brief Sanitizes the file path. 435 * @brief Sanitizes the file path.
436 * @details This function takes care of adding the current working directory if its a
437 * relative path and also removes all '..' and '//' references in the original
438 * path.
444 * 439 *
445 * @param[in] path The path to sanitize 440 * @param[in] path The path to sanitize
446 * 441 *
447 * @return An allocated string with the sanitized path 442 * @return An allocated string with the sanitized path
448 * 443 *
449 * @details This function takes care of adding the current working directory if its a
450 * relative path and also removes all '..' and '//' references in the original
451 * path.
452 *
453 * @since 1.1 444 * @since 1.1
454 */ 445 */
455EAPI char *eina_file_path_sanitize(const char *path); 446EAPI char *eina_file_path_sanitize(const char *path);
@@ -475,7 +466,9 @@ typedef enum {
475} Eina_File_Copy_Flags; 466} Eina_File_Copy_Flags;
476 467
477/** 468/**
478 * @brief Copy one file to another using the fastest possible way and report progress. 469 * @brief Copies one file to another using the fastest possible way and report progress.
470 * @details This function tries to splice if it is available. It is blocked
471 * until the whole file is copied or it fails.
479 * 472 *
480 * @param[in] src The source file. 473 * @param[in] src The source file.
481 * @param[in] dst The destination file. 474 * @param[in] dst The destination file.
@@ -485,31 +478,27 @@ typedef enum {
485 * @return #EINA_TRUE on success, #EINA_FALSE otherwise (and @p dst 478 * @return #EINA_TRUE on success, #EINA_FALSE otherwise (and @p dst
486 * will be deleted) 479 * will be deleted)
487 * 480 *
488 * @details This function tries to splice if it is available. It is blocked
489 * until the whole file is copied or it fails.
490 *
491 * @note During the progress it may call back @p cb with the progress summary. 481 * @note During the progress it may call back @p cb with the progress summary.
492 */ 482 */
493EAPI Eina_Bool eina_file_copy(const char *src, const char *dst, Eina_File_Copy_Flags flags, Eina_File_Copy_Progress cb, const void *cb_data) EINA_ARG_NONNULL(1, 2); 483EAPI Eina_Bool eina_file_copy(const char *src, const char *dst, Eina_File_Copy_Flags flags, Eina_File_Copy_Progress cb, const void *cb_data) EINA_ARG_NONNULL(1, 2);
494 484
495/** 485/**
496 * @brief Gets a read-only handler to a file. 486 * @brief Gets a read-only handler to a file.
487 * @details This opens a file in the read-only mode. @p name should be an absolute path. An
488 * #Eina_File handle can be shared among multiple instances if @p shared
489 * is #EINA_TRUE, otherwise.
497 * 490 *
498 * @param[in] name The filename to open 491 * @param[in] name The filename to open
499 * @param[in] shared Requested a shm 492 * @param[in] shared Requested a shm
500 493
501 * @return An #Eina_File handle to the file 494 * @return An #Eina_File handle to the file
502 * 495 *
503 * @details This opens a file in the read-only mode. @p name should be an absolute path. An
504 * #Eina_File handle can be shared among multiple instances if @p shared
505 * is #EINA_TRUE, otherwise.
506 *
507 * @since 1.1 496 * @since 1.1
508 */ 497 */
509EAPI Eina_File *eina_file_open(const char *name, Eina_Bool shared) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC; 498EAPI Eina_File *eina_file_open(const char *name, Eina_Bool shared) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC;
510 499
511/** 500/**
512 * @brief Create a virtual file from a memory pointer. 501 * @brief Creates a virtual file from a memory pointer.
513 * 502 *
514 * @param[in] virtual_name A virtual name for Eina_File, if @c NULL, a generated one will be given 503 * @param[in] virtual_name A virtual name for Eina_File, if @c NULL, a generated one will be given
515 * @param[in] data The memory pointer to take data from 504 * @param[in] data The memory pointer to take data from
@@ -523,7 +512,7 @@ EAPI Eina_File *
523eina_file_virtualize(const char *virtual_name, const void *data, unsigned long long length, Eina_Bool copy) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); 512eina_file_virtualize(const char *virtual_name, const void *data, unsigned long long length, Eina_Bool copy) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
524 513
525/** 514/**
526 * @brief Tells if a file is a real file or only exist in memory 515 * @brief Tells if a file is a real file or only exist in memory.
527 * 516 *
528 * @param file The file to test 517 * @param file The file to test
529 * @return #EINA_TRUE if the file is a virtual file 518 * @return #EINA_TRUE if the file is a virtual file
@@ -534,14 +523,13 @@ EAPI Eina_Bool
534eina_file_virtual(Eina_File *file) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); 523eina_file_virtual(Eina_File *file) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
535 524
536/** 525/**
537 * @brief Refreshes file information 526 * @brief Refreshes file information.
527 * @details All current map continue to exist. You need to manually delete
528 * and recreate them to have the new correct mapping.
538 * 529 *
539 * @param file The file to refresh 530 * @param file The file to refresh
540 * @return #EINA_TRUE if the file has changed 531 * @return #EINA_TRUE if the file has changed
541 * 532 *
542 * @details All current map continue to exist. You need to manually delete
543 * and recreate them to have the new correct mapping.
544 *
545 * @since 1.8 533 * @since 1.8
546 */ 534 */
547EAPI Eina_Bool eina_file_refresh(Eina_File *file); 535EAPI Eina_Bool eina_file_refresh(Eina_File *file);
@@ -560,11 +548,10 @@ EAPI Eina_File * eina_file_dup(const Eina_File *file);
560 548
561/** 549/**
562 * @brief Unrefs the file handler. 550 * @brief Unrefs the file handler.
551 * @details This decrements the file's reference count and if it reaches zero it closes the file.
563 * 552 *
564 * @param[in] file The file handler to unref 553 * @param[in] file The file handler to unref
565 * 554 *
566 * @details This decrements the file's reference count and if it reaches zero it closes the file.
567 *
568 * @since 1.1 555 * @since 1.1
569 */ 556 */
570EAPI void eina_file_close(Eina_File *file); 557EAPI void eina_file_close(Eina_File *file);
@@ -666,7 +653,10 @@ EAPI void *eina_file_map_new(Eina_File *file, Eina_File_Populate rule,
666EAPI void eina_file_map_free(Eina_File *file, void *map); 653EAPI void eina_file_map_free(Eina_File *file, void *map);
667 654
668/** 655/**
669 * @brief Ask the OS to populate or otherwise pages of memory in file mapping 656 * @brief Asks the OS to populate or otherwise pages of memory in file mapping.
657 * @details This advises the operating system as to what to do with the memory mapped
658 * to the given @p file. This affects a specific range of memory and may not
659 * be honoured if the system chooses to ignore the request.
670 * 660 *
671 * @param[in] file The file handle from which the map comes 661 * @param[in] file The file handle from which the map comes
672 * @param[in] rule The rule to apply to the mapped memory 662 * @param[in] rule The rule to apply to the mapped memory
@@ -674,10 +664,6 @@ EAPI void eina_file_map_free(Eina_File *file, void *map);
674 * @param[in] offset The offset in bytes from the start of the map address 664 * @param[in] offset The offset in bytes from the start of the map address
675 * @param [in]length The length in bytes of the memory region to populate 665 * @param [in]length The length in bytes of the memory region to populate
676 * 666 *
677 * @details This advises the operating system as to what to do with the memory mapped
678 * to the given @p file. This affects a specific range of memory and may not
679 * be honored if the system chooses to ignore the request.
680 *
681 * @since 1.8 667 * @since 1.8
682 */ 668 */
683EAPI void 669EAPI void
@@ -686,20 +672,19 @@ eina_file_map_populate(Eina_File *file, Eina_File_Populate rule, const void *map
686 672
687/** 673/**
688 * @brief Maps line by line in the memory efficiently using an #Eina_Iterator. 674 * @brief Maps line by line in the memory efficiently using an #Eina_Iterator.
689 *
690 * @param[in] file The file to run over
691 * @return An Eina_Iterator that produces #Eina_File_Line
692 *
693 * @details This function returns an iterator that acts like fgets without 675 * @details This function returns an iterator that acts like fgets without
694 * useless memcpy. Be aware that once eina_iterator_next has been called, 676 * useless memcpy. Be aware that once eina_iterator_next has been called,
695 * nothing can guarantee that the memory is still going to be mapped. 677 * nothing can guarantee that the memory is still going to be mapped.
696 * 678 *
679 * @param[in] file The file to run over
680 * @return An Eina_Iterator that produces #Eina_File_Line
681 *
697 * @since 1.3 682 * @since 1.3
698 */ 683 */
699EAPI Eina_Iterator *eina_file_map_lines(Eina_File *file); 684EAPI Eina_Iterator *eina_file_map_lines(Eina_File *file);
700 685
701/** 686/**
702 * @brief Tells whether there has been an IO error during the life of a mmaped file, 687 * @brief Tells whether there has been an IO error during the life of a mmaped file.
703 * 688 *
704 * @param[in] file The file handler to the mmaped file 689 * @param[in] file The file handler to the mmaped file
705 * @param[in] map The memory map to check if an error occurred on it 690 * @param[in] map The memory map to check if an error occurred on it
@@ -710,7 +695,9 @@ EAPI Eina_Iterator *eina_file_map_lines(Eina_File *file);
710EAPI Eina_Bool eina_file_map_faulted(Eina_File *file, void *map); 695EAPI Eina_Bool eina_file_map_faulted(Eina_File *file, void *map);
711 696
712/** 697/**
713 * @brief Join two paths of known length. 698 * @brief Joins two paths of known length.
699 * @details This function is similar to eina_str_join_len(), but the separator
700 * is '\' on Windows and '/' otherwise.
714 * 701 *
715 * @param dst The buffer to store the result. 702 * @param dst The buffer to store the result.
716 * @param size Size (in byte) of the buffer. 703 * @param size Size (in byte) of the buffer.
@@ -720,9 +707,6 @@ EAPI Eina_Bool eina_file_map_faulted(Eina_File *file, void *map);
720 * @param b_len length of @p b. 707 * @param b_len length of @p b.
721 * @return The number of characters printed. 708 * @return The number of characters printed.
722 * 709 *
723 * This function is similar to eina_str_join_len(), but the separator
724 * is '\' on Windows and '/' otherwise.
725 *
726 * @see eina_str_join_len() 710 * @see eina_str_join_len()
727 * @see eina_file_path_join() 711 * @see eina_file_path_join()
728 * 712 *
@@ -736,7 +720,10 @@ static inline size_t eina_file_path_join_len(char *dst,
736 size_t b_len); 720 size_t b_len);
737 721
738/** 722/**
739 * @brief Join two paths of known length. 723 * @brief Joins two paths of known length.
724 * @details This function is similar to eina_file_path_join_len(), but will compute
725 * the length of @p a and @p b using strlen(). The path separator is
726 * '\' on Windows and '/' otherwise.
740 * 727 *
741 * @param dst The buffer to store the result. 728 * @param dst The buffer to store the result.
742 * @param size Size (in byte) of the buffer. 729 * @param size Size (in byte) of the buffer.
@@ -744,10 +731,6 @@ static inline size_t eina_file_path_join_len(char *dst,
744 * @param b Second string to use. 731 * @param b Second string to use.
745 * @return The number of characters printed. 732 * @return The number of characters printed.
746 * 733 *
747 * This function is similar to eina_file_path_join_len(), but will compute
748 * the length of @p a and @p b using strlen(). The path separator is
749 * '\' on Windows and '/' otherwise.
750 *
751 * @see eina_file_path_join_len() 734 * @see eina_file_path_join_len()
752 * 735 *
753 * @since 1.16 736 * @since 1.16
@@ -759,14 +742,13 @@ static inline size_t eina_file_path_join(char *dst,
759 742
760 743
761/** 744/**
762 * @brief Unlink file 745 * @brief Unlinks file.
746 * @details This function is a wrapper around the unlink() system call. It removes a link to
747 * a file.
763 * 748 *
764 * @param pathname File name to unlink. 749 * @param pathname File name to unlink.
765 * @return #EINA_TRUE if the unlink was successfull, #EINA_FALSE otherwise.. 750 * @return #EINA_TRUE if the unlink was successfull, #EINA_FALSE otherwise..
766 * 751 *
767 * This function is a wrapper around the unlink() system call. It removes a link to
768 * a file.
769 *
770 * @since 1.19 752 * @since 1.19
771 */ 753 */
772EAPI Eina_Bool eina_file_unlink(const char *pathname); 754EAPI Eina_Bool eina_file_unlink(const char *pathname);
diff --git a/src/lib/eina/eina_fp.h b/src/lib/eina/eina_fp.h
index 80aefff7a5..b176aca62e 100644
--- a/src/lib/eina/eina_fp.h
+++ b/src/lib/eina/eina_fp.h
@@ -76,7 +76,7 @@ typedef int32_t Eina_F16p16;
76typedef int32_t Eina_F8p24; 76typedef int32_t Eina_F8p24;
77 77
78/** 78/**
79 * @brief Create a new Eina_F32p32 floating point number from standard 32-bit 79 * @brief Creates a new Eina_F32p32 floating point number from standard 32-bit
80 * integer 80 * integer
81 * 81 *
82 * @param v 32-bit integer value to convert 82 * @param v 32-bit integer value to convert
@@ -85,7 +85,7 @@ typedef int32_t Eina_F8p24;
85static inline Eina_F32p32 eina_f32p32_int_from(int32_t v); 85static inline Eina_F32p32 eina_f32p32_int_from(int32_t v);
86 86
87/** 87/**
88 * @brief Create a new standard 32-bit integer from Eina_F32p32 floating point 88 * @brief Creates a new standard 32-bit integer from Eina_F32p32 floating point
89 * number 89 * number
90 * 90 *
91 * @param v Eina_F32p32 value to convert 91 * @param v Eina_F32p32 value to convert
@@ -94,15 +94,15 @@ static inline Eina_F32p32 eina_f32p32_int_from(int32_t v);
94static inline int32_t eina_f32p32_int_to(Eina_F32p32 v); 94static inline int32_t eina_f32p32_int_to(Eina_F32p32 v);
95 95
96/** 96/**
97 * @brief Create a new Eina_F32p32 floating point number from standard double 97 * @brief Creates a new Eina_F32p32 floating point number from standard double
98 * 98 *
99 * @param v double value to convert 99 * @param v Double value to convert
100 * @return The value converted into Eina_F32p32 format 100 * @return The value converted into Eina_F32p32 format
101 */ 101 */
102static inline Eina_F32p32 eina_f32p32_double_from(double v); 102static inline Eina_F32p32 eina_f32p32_double_from(double v);
103 103
104/** 104/**
105 * @brief Create a new standard double from Eina_F32p32 floating point 105 * @brief Creates a new standard double from Eina_F32p32 floating point
106 * number 106 * number
107 * 107 *
108 * @param v Eina_F32p32 value to convert 108 * @param v Eina_F32p32 value to convert
@@ -120,11 +120,11 @@ static inline double eina_f32p32_double_to(Eina_F32p32 v);
120static inline Eina_F32p32 eina_f32p32_add(Eina_F32p32 a, Eina_F32p32 b); 120static inline Eina_F32p32 eina_f32p32_add(Eina_F32p32 a, Eina_F32p32 b);
121 121
122/** 122/**
123 * @brief Calculates the substraction of two Eina_F32p32 floating point numbers 123 * @brief Calculates the subtraction of two Eina_F32p32 floating point numbers
124 * 124 *
125 * @param a The first number 125 * @param a The first number
126 * @param b The substracted number 126 * @param b The subtracted number
127 * @return The substaction result of the two numbers @p a - @p b 127 * @return The subtraction result of the two numbers @p a - @p b
128 */ 128 */
129static inline Eina_F32p32 eina_f32p32_sub(Eina_F32p32 a, Eina_F32p32 b); 129static inline Eina_F32p32 eina_f32p32_sub(Eina_F32p32 a, Eina_F32p32 b);
130 130
@@ -133,7 +133,7 @@ static inline Eina_F32p32 eina_f32p32_sub(Eina_F32p32 a, Eina_F32p32 b);
133 * 133 *
134 * @param a The first number 134 * @param a The first number
135 * @param b The second number 135 * @param b The second number
136 * @return The mutliplication result of the two numbers @p a * @p b 136 * @return The multiplication result of the two numbers @p a * @p b
137 * 137 *
138 * To prevent overflow during multiplication we need to reduce the precision of 138 * To prevent overflow during multiplication we need to reduce the precision of
139 * the fraction part Shift both values to only contain 16 bit of the fraction 139 * the fraction part Shift both values to only contain 16 bit of the fraction
@@ -148,7 +148,7 @@ static inline Eina_F32p32 eina_f32p32_mul(Eina_F32p32 a, Eina_F32p32 b);
148 * 148 *
149 * @param a The Eina_F32p32 number 149 * @param a The Eina_F32p32 number
150 * @param b The integer value 150 * @param b The integer value
151 * @return The mutliplication result of the two numbers @p a * @p b 151 * @return The multiplication result of the two numbers @p a * @p b
152 */ 152 */
153static inline Eina_F32p32 eina_f32p32_scale(Eina_F32p32 a, int b); 153static inline Eina_F32p32 eina_f32p32_scale(Eina_F32p32 a, int b);
154 154
@@ -170,7 +170,7 @@ static inline Eina_F32p32 eina_f32p32_div(Eina_F32p32 a, Eina_F32p32 b);
170static inline Eina_F32p32 eina_f32p32_sqrt(Eina_F32p32 a); 170static inline Eina_F32p32 eina_f32p32_sqrt(Eina_F32p32 a);
171 171
172/** 172/**
173 * @brief Get the absolute value of the integer part of and Eina_F32p32 floating 173 * @brief Gets the absolute value of the integer part of and Eina_F32p32 floating
174 * point number 174 * point number
175 * 175 *
176 * @param v The floating point number 176 * @param v The floating point number
@@ -179,7 +179,7 @@ static inline Eina_F32p32 eina_f32p32_sqrt(Eina_F32p32 a);
179static inline unsigned int eina_f32p32_fracc_get(Eina_F32p32 v); 179static inline unsigned int eina_f32p32_fracc_get(Eina_F32p32 v);
180 180
181/** 181/**
182 * @brief Get the absolute value of an Eina_F32p32 floating point number 182 * @brief Gets the absolute value of an Eina_F32p32 floating point number
183 * 183 *
184 * @param a The floating point number 184 * @param a The floating point number
185 * @return The absolute value for the number @p a 185 * @return The absolute value for the number @p a
@@ -220,7 +220,7 @@ EAPI Eina_F32p32 eina_f32p32_sin(Eina_F32p32 a);
220#define EINA_F16P16_HALF (1 << 15) 220#define EINA_F16P16_HALF (1 << 15)
221 221
222/** 222/**
223 * @brief Create a new Eina_F16p316 floating point number from standard 32-bit 223 * @brief Creates a new Eina_F16p316 floating point number from standard 32-bit
224 * integer 224 * integer
225 * 225 *
226 * @param v 32-bit integer value to convert 226 * @param v 32-bit integer value to convert
@@ -229,7 +229,7 @@ EAPI Eina_F32p32 eina_f32p32_sin(Eina_F32p32 a);
229static inline Eina_F16p16 eina_f16p16_int_from(int32_t v); 229static inline Eina_F16p16 eina_f16p16_int_from(int32_t v);
230 230
231/** 231/**
232 * @brief Create a new standard 32-bit integer from Eina_F16p16 floating point 232 * @brief Creates a new standard 32-bit integer from Eina_F16p16 floating point
233 * number 233 * number
234 * 234 *
235 * @param v Eina_F16p16 value to convert 235 * @param v Eina_F16p16 value to convert
@@ -238,15 +238,15 @@ static inline Eina_F16p16 eina_f16p16_int_from(int32_t v);
238static inline int32_t eina_f16p16_int_to(Eina_F16p16 v); 238static inline int32_t eina_f16p16_int_to(Eina_F16p16 v);
239 239
240/** 240/**
241 * @brief Create a new Eina_F16p16 floating point number from standard double 241 * @brief Creates a new Eina_F16p16 floating point number from standard double
242 * 242 *
243 * @param v double value to convert 243 * @param v Double value to convert
244 * @return The value converted into Eina_F16p16 format 244 * @return The value converted into Eina_F16p16 format
245 */ 245 */
246static inline Eina_F16p16 eina_f16p16_double_from(double v); 246static inline Eina_F16p16 eina_f16p16_double_from(double v);
247 247
248/** 248/**
249 * @brief Create a new standard double from Eina_F16p16 floating point 249 * @brief Creates a new standard double from Eina_F16p16 floating point
250 * number 250 * number
251 * 251 *
252 * @param v Eina_F16p16 value to convert 252 * @param v Eina_F16p16 value to convert
@@ -255,15 +255,15 @@ static inline Eina_F16p16 eina_f16p16_double_from(double v);
255static inline double eina_f16p16_double_to(Eina_F16p16 v); 255static inline double eina_f16p16_double_to(Eina_F16p16 v);
256 256
257/** 257/**
258 * @brief Create a new Eina_F16p16 floating point number from standard float 258 * @brief Creates a new Eina_F16p16 floating point number from standard float
259 * 259 *
260 * @param v float value to convert 260 * @param v Float value to convert
261 * @return The value converted into Eina_F16p16 format 261 * @return The value converted into Eina_F16p16 format
262 */ 262 */
263static inline Eina_F16p16 eina_f16p16_float_from(float v); 263static inline Eina_F16p16 eina_f16p16_float_from(float v);
264 264
265/** 265/**
266 * @brief Create a new standard float from Eina_F16p16 floating point 266 * @brief Creates a new standard float from Eina_F16p16 floating point
267 * number 267 * number
268 * 268 *
269 * @param v Eina_F16p16 value to convert 269 * @param v Eina_F16p16 value to convert
@@ -281,11 +281,11 @@ static inline float eina_f16p16_float_to(Eina_F16p16 v);
281static inline Eina_F16p16 eina_f16p16_add(Eina_F16p16 a, Eina_F16p16 b); 281static inline Eina_F16p16 eina_f16p16_add(Eina_F16p16 a, Eina_F16p16 b);
282 282
283/** 283/**
284 * @brief Calculates the substraction of two Eina_F16p16 floating point numbers 284 * @brief Calculates the subtraction of two Eina_F16p16 floating point numbers
285 * 285 *
286 * @param a The first number 286 * @param a The first number
287 * @param b The substracted number 287 * @param b The subtracted number
288 * @return The substaction result of the two numbers @p a - @p b 288 * @return The subtraction result of the two numbers @p a - @p b
289 */ 289 */
290static inline Eina_F16p16 eina_f16p16_sub(Eina_F16p16 a, Eina_F16p16 b); 290static inline Eina_F16p16 eina_f16p16_sub(Eina_F16p16 a, Eina_F16p16 b);
291 291
@@ -294,7 +294,7 @@ static inline Eina_F16p16 eina_f16p16_sub(Eina_F16p16 a, Eina_F16p16 b);
294 * 294 *
295 * @param a The first number 295 * @param a The first number
296 * @param b The second number 296 * @param b The second number
297 * @return The mutliplication result of the two numbers @p a * @p b 297 * @return The multiplication result of the two numbers @p a * @p b
298 */ 298 */
299static inline Eina_F16p16 eina_f16p16_mul(Eina_F16p16 a, Eina_F16p16 b); 299static inline Eina_F16p16 eina_f16p16_mul(Eina_F16p16 a, Eina_F16p16 b);
300 300
@@ -304,7 +304,7 @@ static inline Eina_F16p16 eina_f16p16_mul(Eina_F16p16 a, Eina_F16p16 b);
304 * 304 *
305 * @param a The Eina_F16p16 number 305 * @param a The Eina_F16p16 number
306 * @param b The integer value 306 * @param b The integer value
307 * @return The mutliplication result of the two numbers @p a * @p b 307 * @return The multiplication result of the two numbers @p a * @p b
308 */ 308 */
309static inline Eina_F16p16 eina_f16p16_scale(Eina_F16p16 a, int b); 309static inline Eina_F16p16 eina_f16p16_scale(Eina_F16p16 a, int b);
310 310
@@ -326,7 +326,7 @@ static inline Eina_F16p16 eina_f16p16_div(Eina_F16p16 a, Eina_F16p16 b);
326static inline Eina_F16p16 eina_f16p16_sqrt(Eina_F16p16 a); 326static inline Eina_F16p16 eina_f16p16_sqrt(Eina_F16p16 a);
327 327
328/** 328/**
329 * @brief Get the absolute value of the integer part of and Eina_F16p16 floating 329 * @brief Gets the absolute value of the integer part of and Eina_F16p16 floating
330 * point number 330 * point number
331 * 331 *
332 * @param v The floating point number 332 * @param v The floating point number
@@ -336,7 +336,7 @@ static inline unsigned int eina_f16p16_fracc_get(Eina_F16p16 v);
336 336
337 337
338/** 338/**
339 * @brief Create a new Eina_F16p316 floating point number from standard 32-bit 339 * @brief Creates a new Eina_F16p316 floating point number from standard 32-bit
340 * integer 340 * integer
341 * 341 *
342 * @param v 32-bit integer value to convert 342 * @param v 32-bit integer value to convert
@@ -345,7 +345,7 @@ static inline unsigned int eina_f16p16_fracc_get(Eina_F16p16 v);
345static inline Eina_F8p24 eina_f8p24_int_from(int32_t v); 345static inline Eina_F8p24 eina_f8p24_int_from(int32_t v);
346 346
347/** 347/**
348 * @brief Create a new standard 32-bit integer from Eina_F8p24 floating point 348 * @brief Creates a new standard 32-bit integer from Eina_F8p24 floating point
349 * number 349 * number
350 * 350 *
351 * @param v Eina_F8p24 value to convert 351 * @param v Eina_F8p24 value to convert
@@ -354,9 +354,9 @@ static inline Eina_F8p24 eina_f8p24_int_from(int32_t v);
354static inline int32_t eina_f8p24_int_to(Eina_F8p24 v); 354static inline int32_t eina_f8p24_int_to(Eina_F8p24 v);
355 355
356/** 356/**
357 * @brief Create a new Eina_F8p24 floating point number from standard float 357 * @brief Creates a new Eina_F8p24 floating point number from standard float
358 * 358 *
359 * @param v float value to convert 359 * @param v Float value to convert
360 * @return The value converted into Eina_F8p24 format 360 * @return The value converted into Eina_F8p24 format
361 */ 361 */
362static inline Eina_F8p24 eina_f8p24_float_from(float v); 362static inline Eina_F8p24 eina_f8p24_float_from(float v);
@@ -379,11 +379,11 @@ static inline float eina_f8p24_float_to(Eina_F8p24 v);
379static inline Eina_F8p24 eina_f8p24_add(Eina_F8p24 a, Eina_F8p24 b); 379static inline Eina_F8p24 eina_f8p24_add(Eina_F8p24 a, Eina_F8p24 b);
380 380
381/** 381/**
382 * @brief Calculates the substraction of two Eina_F8p24 floating point numbers 382 * @brief Calculates the subtraction of two Eina_F8p24 floating point numbers
383 * 383 *
384 * @param a The first number 384 * @param a The first number
385 * @param b The substracted number 385 * @param b The subtracted number
386 * @return The substaction result of the two numbers @p a - @p b 386 * @return The subtraction result of the two numbers @p a - @p b
387 */ 387 */
388static inline Eina_F8p24 eina_f8p24_sub(Eina_F8p24 a, Eina_F8p24 b); 388static inline Eina_F8p24 eina_f8p24_sub(Eina_F8p24 a, Eina_F8p24 b);
389 389
@@ -392,7 +392,7 @@ static inline Eina_F8p24 eina_f8p24_sub(Eina_F8p24 a, Eina_F8p24 b);
392 * 392 *
393 * @param a The first number 393 * @param a The first number
394 * @param b The second number 394 * @param b The second number
395 * @return The mutliplication result of the two numbers @p a * @p b 395 * @return The multiplication result of the two numbers @p a * @p b
396 */ 396 */
397static inline Eina_F8p24 eina_f8p24_mul(Eina_F8p24 a, Eina_F8p24 b); 397static inline Eina_F8p24 eina_f8p24_mul(Eina_F8p24 a, Eina_F8p24 b);
398 398
@@ -402,7 +402,7 @@ static inline Eina_F8p24 eina_f8p24_mul(Eina_F8p24 a, Eina_F8p24 b);
402 * 402 *
403 * @param a The Eina_F16p16 number 403 * @param a The Eina_F16p16 number
404 * @param b The integer value 404 * @param b The integer value
405 * @return The mutliplication result of the two numbers @p a * @p b 405 * @return The multiplication result of the two numbers @p a * @p b
406 */ 406 */
407static inline Eina_F8p24 eina_f8p24_scale(Eina_F8p24 a, int b); 407static inline Eina_F8p24 eina_f8p24_scale(Eina_F8p24 a, int b);
408 408
@@ -424,7 +424,7 @@ static inline Eina_F8p24 eina_f8p24_div(Eina_F8p24 a, Eina_F8p24 b);
424static inline Eina_F8p24 eina_f8p24_sqrt(Eina_F8p24 a); 424static inline Eina_F8p24 eina_f8p24_sqrt(Eina_F8p24 a);
425 425
426/** 426/**
427 * @brief Get the absolute value of the integer part of and Eina_F8p24 floating 427 * @brief Gets the absolute value of the integer part of and Eina_F8p24 floating
428 * point number 428 * point number
429 * 429 *
430 * @param v The floating point number 430 * @param v The floating point number
diff --git a/src/lib/eina/eina_hamster.h b/src/lib/eina/eina_hamster.h
index bea759d57f..e5b7129f04 100644
--- a/src/lib/eina/eina_hamster.h
+++ b/src/lib/eina/eina_hamster.h
@@ -39,7 +39,7 @@
39 39
40 40
41/** 41/**
42 * @brief Get the hamster count. 42 * @brief Gets the hamster count.
43 * 43 *
44 * @return The number of available hamsters. 44 * @return The number of available hamsters.
45 * 45 *
diff --git a/src/lib/eina/eina_hash.h b/src/lib/eina/eina_hash.h
index 5f953bf865..e66442066f 100644
--- a/src/lib/eina/eina_hash.h
+++ b/src/lib/eina/eina_hash.h
@@ -77,7 +77,7 @@
77 * @until printf("\n"); 77 * @until printf("\n");
78 * 78 *
79 * There are different ways of iterate over the entries of a hash. Here we show 79 * There are different ways of iterate over the entries of a hash. Here we show
80 * two of them: using @ref eina_hash_foreach and @ref Eina_Iterator . 80 * two of them: using @ref eina_hash_foreach and @ref Eina_Iterator.
81 * 81 *
82 * @skip List of phones 82 * @skip List of phones
83 * @until eina_iterator_free(it); 83 * @until eina_iterator_free(it);
@@ -346,7 +346,7 @@ typedef Eina_Bool (*Eina_Hash_Foreach)(const Eina_Hash *hash, const void *key
346 346
347 347
348/** 348/**
349 * @brief Create a new hash table. 349 * @brief Creates a new hash table.
350 * 350 *
351 * @param key_length_cb The function called when getting the size of the key. 351 * @param key_length_cb The function called when getting the size of the key.
352 * @param key_cmp_cb The function called when comparing the keys. 352 * @param key_cmp_cb The function called when comparing the keys.
@@ -381,7 +381,7 @@ EAPI Eina_Hash *eina_hash_new(Eina_Key_Length key_length_cb,
381 int buckets_power_size) EINA_MALLOC EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(2, 3); 381 int buckets_power_size) EINA_MALLOC EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(2, 3);
382 382
383/** 383/**
384 * @brief Redefine the callback that clean the data of a hash 384 * @brief Redefines the callback that clean the data of a hash.
385 * 385 *
386 * @param hash The given hash table 386 * @param hash The given hash table
387 * @param data_free_cb The function called on each value when the hash 387 * @param data_free_cb The function called on each value when the hash
@@ -397,7 +397,7 @@ EAPI Eina_Hash *eina_hash_new(Eina_Key_Length key_length_cb,
397EAPI void eina_hash_free_cb_set(Eina_Hash *hash, Eina_Free_Cb data_free_cb) EINA_ARG_NONNULL(1); 397EAPI void eina_hash_free_cb_set(Eina_Hash *hash, Eina_Free_Cb data_free_cb) EINA_ARG_NONNULL(1);
398 398
399/** 399/**
400 * @brief Create a new hash table using the djb2 algorithm. 400 * @brief Creates a new hash table using the djb2 algorithm.
401 * 401 *
402 * @param data_free_cb The function called on each value when the hash table 402 * @param data_free_cb The function called on each value when the hash table
403 * is freed, or when an item is deleted from it. @c NULL can be passed as 403 * is freed, or when an item is deleted from it. @c NULL can be passed as
@@ -412,7 +412,7 @@ EAPI void eina_hash_free_cb_set(Eina_Hash *hash, Eina_Free_Cb data_free_cb) EINA
412EAPI Eina_Hash *eina_hash_string_djb2_new(Eina_Free_Cb data_free_cb); 412EAPI Eina_Hash *eina_hash_string_djb2_new(Eina_Free_Cb data_free_cb);
413 413
414/** 414/**
415 * @brief Create a new hash table for use with strings. 415 * @brief Creates a new hash table for use with strings.
416 * 416 *
417 * @param data_free_cb The function called on each value when the hash table 417 * @param data_free_cb The function called on each value when the hash table
418 * is freed, or when an item is deleted from it. @c NULL can be passed as 418 * is freed, or when an item is deleted from it. @c NULL can be passed as
@@ -431,7 +431,7 @@ EAPI Eina_Hash *eina_hash_string_djb2_new(Eina_Free_Cb data_free_cb);
431EAPI Eina_Hash *eina_hash_string_superfast_new(Eina_Free_Cb data_free_cb); 431EAPI Eina_Hash *eina_hash_string_superfast_new(Eina_Free_Cb data_free_cb);
432 432
433/** 433/**
434 * @brief Create a new hash table for use with strings with small bucket size. 434 * @brief Creates a new hash table for use with strings with small bucket size.
435 * 435 *
436 * @param data_free_cb The function called on each value when the hash table 436 * @param data_free_cb The function called on each value when the hash table
437 * is freed, or when an item is deleted from it. @c NULL can be passed as 437 * is freed, or when an item is deleted from it. @c NULL can be passed as
@@ -449,7 +449,7 @@ EAPI Eina_Hash *eina_hash_string_superfast_new(Eina_Free_Cb data_free_cb);
449EAPI Eina_Hash *eina_hash_string_small_new(Eina_Free_Cb data_free_cb); 449EAPI Eina_Hash *eina_hash_string_small_new(Eina_Free_Cb data_free_cb);
450 450
451/** 451/**
452 * @brief Create a new hash table for use with 32bit integers. 452 * @brief Creates a new hash table for use with 32bit integers.
453 * 453 *
454 * @param data_free_cb The function called on each value when the hash table 454 * @param data_free_cb The function called on each value when the hash table
455 * is freed, or when an item is deleted from it. @c NULL can be passed as 455 * is freed, or when an item is deleted from it. @c NULL can be passed as
@@ -468,7 +468,7 @@ EAPI Eina_Hash *eina_hash_string_small_new(Eina_Free_Cb data_free_cb);
468EAPI Eina_Hash *eina_hash_int32_new(Eina_Free_Cb data_free_cb); 468EAPI Eina_Hash *eina_hash_int32_new(Eina_Free_Cb data_free_cb);
469 469
470/** 470/**
471 * @brief Create a new hash table for use with 64bit integers. 471 * @brief Creates a new hash table for use with 64bit integers.
472 * 472 *
473 * @param data_free_cb The function called on each value when the hash table 473 * @param data_free_cb The function called on each value when the hash table
474 * is freed, or when an item is deleted from it. @c NULL can be passed as 474 * is freed, or when an item is deleted from it. @c NULL can be passed as
@@ -486,7 +486,7 @@ EAPI Eina_Hash *eina_hash_int32_new(Eina_Free_Cb data_free_cb);
486EAPI Eina_Hash *eina_hash_int64_new(Eina_Free_Cb data_free_cb); 486EAPI Eina_Hash *eina_hash_int64_new(Eina_Free_Cb data_free_cb);
487 487
488/** 488/**
489 * @brief Create a new hash table for use with pointers. 489 * @brief Creates a new hash table for use with pointers.
490 * 490 *
491 * @param data_free_cb The function called on each value when the hash table 491 * @param data_free_cb The function called on each value when the hash table
492 * is freed, or when an item is deleted from it. @c NULL can be passed as 492 * is freed, or when an item is deleted from it. @c NULL can be passed as
@@ -512,7 +512,7 @@ EAPI Eina_Hash *eina_hash_int64_new(Eina_Free_Cb data_free_cb);
512EAPI Eina_Hash *eina_hash_pointer_new(Eina_Free_Cb data_free_cb); 512EAPI Eina_Hash *eina_hash_pointer_new(Eina_Free_Cb data_free_cb);
513 513
514/** 514/**
515 * @brief Create a new hash table optimized for stringshared values. 515 * @brief Creates a new hash table optimized for stringshared values.
516 * 516 *
517 * @param data_free_cb The function called on each value when the hash table 517 * @param data_free_cb The function called on each value when the hash table
518 * is freed, or when an item is deleted from it. @c NULL can be passed as 518 * is freed, or when an item is deleted from it. @c NULL can be passed as
@@ -538,7 +538,7 @@ EAPI Eina_Hash *eina_hash_pointer_new(Eina_Free_Cb data_free_cb);
538EAPI Eina_Hash *eina_hash_stringshared_new(Eina_Free_Cb data_free_cb); 538EAPI Eina_Hash *eina_hash_stringshared_new(Eina_Free_Cb data_free_cb);
539 539
540/** 540/**
541 * @brief Add an entry to the given hash table. 541 * @brief Adds an entry to the given hash table.
542 * 542 *
543 * @param hash The given hash table. Cannot be @c NULL. 543 * @param hash The given hash table. Cannot be @c NULL.
544 * @param key A unique key. Cannot be @c NULL. 544 * @param key A unique key. Cannot be @c NULL.
@@ -563,7 +563,7 @@ EAPI Eina_Bool eina_hash_add(Eina_Hash *hash,
563 const void *data) EINA_ARG_NONNULL(1, 2, 3); 563 const void *data) EINA_ARG_NONNULL(1, 2, 3);
564 564
565/** 565/**
566 * @brief Add an entry to the given hash table without duplicating the string 566 * @brief Adds an entry to the given hash table without duplicating the string.
567 * key. 567 * key.
568 * 568 *
569 * @param hash The given hash table. Cannot be @c NULL. 569 * @param hash The given hash table. Cannot be @c NULL.
@@ -591,7 +591,7 @@ EAPI Eina_Bool eina_hash_direct_add(Eina_Hash *hash,
591 const void *data) EINA_ARG_NONNULL(1, 2, 3); 591 const void *data) EINA_ARG_NONNULL(1, 2, 3);
592 592
593/** 593/**
594 * @brief Remove the entry identified by a key or a data from the given 594 * @brief Removes the entry identified by a key or a data from the given
595 * hash table. 595 * hash table.
596 * 596 *
597 * @param hash The given hash table. 597 * @param hash The given hash table.
@@ -618,7 +618,7 @@ EAPI Eina_Bool eina_hash_del(Eina_Hash *hash,
618 const void *data) EINA_ARG_NONNULL(1); 618 const void *data) EINA_ARG_NONNULL(1);
619 619
620/** 620/**
621 * @brief Retrieve a specific entry in the given hash table. 621 * @brief Retrieves a specific entry in the given hash table.
622 * 622 *
623 * @param hash The given hash table. 623 * @param hash The given hash table.
624 * @param key The key of the entry to find. 624 * @param key The key of the entry to find.
@@ -634,7 +634,7 @@ EAPI void *eina_hash_find(const Eina_Hash *hash,
634 const void *key) EINA_ARG_NONNULL(2); 634 const void *key) EINA_ARG_NONNULL(2);
635 635
636/** 636/**
637 * @brief Modify the entry pointer at the specified key and return the old 637 * @brief Modifies the entry pointer at the specified key and return the old
638 * entry. 638 * entry.
639 * @param hash The given hash table. 639 * @param hash The given hash table.
640 * @param key The key of the entry to modify. 640 * @param key The key of the entry to modify.
@@ -651,7 +651,7 @@ EAPI void *eina_hash_modify(Eina_Hash *hash,
651 const void *data) EINA_ARG_NONNULL(1, 2, 3); 651 const void *data) EINA_ARG_NONNULL(1, 2, 3);
652 652
653/** 653/**
654 * @brief Modify the entry pointer at the specified key and return the 654 * @brief Modifies the entry pointer at the specified key and return the
655 * old entry or add the entry if not found. 655 * old entry or add the entry if not found.
656 * 656 *
657 * @param hash The given hash table. 657 * @param hash The given hash table.
@@ -670,7 +670,7 @@ EAPI void *eina_hash_set(Eina_Hash *hash,
670 const void *data) EINA_ARG_NONNULL(1, 2); 670 const void *data) EINA_ARG_NONNULL(1, 2);
671 671
672/** 672/**
673 * @brief Change the key associated with a data without triggering the 673 * @brief Changes the key associated with a data without triggering the
674 * free callback. 674 * free callback.
675 * 675 *
676 * @param hash The given hash table. 676 * @param hash The given hash table.
@@ -687,7 +687,7 @@ EAPI Eina_Bool eina_hash_move(Eina_Hash *hash,
687 const void *new_key) EINA_ARG_NONNULL(1, 2, 3); 687 const void *new_key) EINA_ARG_NONNULL(1, 2, 3);
688 688
689/** 689/**
690 * Free the given hash table resources. 690 * @brief Frees the given hash table resources.
691 * 691 *
692 * @param hash The hash table to be freed. 692 * @param hash The hash table to be freed.
693 * 693 *
@@ -711,7 +711,7 @@ EAPI Eina_Bool eina_hash_move(Eina_Hash *hash,
711EAPI void eina_hash_free(Eina_Hash *hash) EINA_ARG_NONNULL(1); 711EAPI void eina_hash_free(Eina_Hash *hash) EINA_ARG_NONNULL(1);
712 712
713/** 713/**
714 * Free the given hash table buckets resources. 714 * @brief Frees the given hash table buckets resources.
715 * 715 *
716 * @param hash The hash table whose buckets have to be freed. 716 * @param hash The hash table whose buckets have to be freed.
717 * 717 *
@@ -736,7 +736,7 @@ EAPI void eina_hash_free_buckets(Eina_Hash *hash) EINA_ARG_NONNULL(1);
736EAPI int eina_hash_population(const Eina_Hash *hash) EINA_ARG_NONNULL(1); 736EAPI int eina_hash_population(const Eina_Hash *hash) EINA_ARG_NONNULL(1);
737 737
738/** 738/**
739 * @brief Add an entry to the given hash table. 739 * @brief Adds an entry to the given hash table.
740 * 740 *
741 * @param hash The given hash table. Cannot be @c NULL. 741 * @param hash The given hash table. Cannot be @c NULL.
742 * @param key A unique key. Cannot be @c NULL. 742 * @param key A unique key. Cannot be @c NULL.
@@ -766,7 +766,7 @@ EAPI Eina_Bool eina_hash_add_by_hash(Eina_Hash *hash,
766 const void *data) EINA_ARG_NONNULL(1, 2, 5); 766 const void *data) EINA_ARG_NONNULL(1, 2, 5);
767 767
768/** 768/**
769 * @brief Add an entry to the given hash table and do not duplicate the string 769 * @brief Adds an entry to the given hash table and do not duplicate the string
770 * key. 770 * key.
771 * 771 *
772 * @param hash The given hash table. Cannot be @c NULL. 772 * @param hash The given hash table. Cannot be @c NULL.
@@ -800,7 +800,7 @@ EAPI Eina_Bool eina_hash_direct_add_by_hash(Eina_Hash *hash,
800 const void *data) EINA_ARG_NONNULL(1, 2, 5); 800 const void *data) EINA_ARG_NONNULL(1, 2, 5);
801 801
802/** 802/**
803 * @brief Remove the entry identified by a key and a key hash from the given 803 * @brief Removes the entry identified by a key and a key hash from the given
804 * hash table. 804 * hash table.
805 * 805 *
806 * @param hash The given hash table. Cannot be @c NULL. 806 * @param hash The given hash table. Cannot be @c NULL.
@@ -817,8 +817,8 @@ EAPI Eina_Bool eina_hash_direct_add_by_hash(Eina_Hash *hash,
817 * functions returns immediately #EINA_FALSE. This function 817 * functions returns immediately #EINA_FALSE. This function
818 * returns #EINA_FALSE if an error occurred, #EINA_TRUE otherwise. 818 * returns #EINA_FALSE if an error occurred, #EINA_TRUE otherwise.
819 * 819 *
820 * @note if you don't have the key_hash, use eina_hash_del_by_key() instead. 820 * @note If you don't have the key_hash, use eina_hash_del_by_key() instead.
821 * @note if you don't have the key, use eina_hash_del_by_data() instead. 821 * @note If you don't have the key, use eina_hash_del_by_data() instead.
822 */ 822 */
823EAPI Eina_Bool eina_hash_del_by_key_hash(Eina_Hash *hash, 823EAPI Eina_Bool eina_hash_del_by_key_hash(Eina_Hash *hash,
824 const void *key, 824 const void *key,
@@ -826,7 +826,7 @@ EAPI Eina_Bool eina_hash_del_by_key_hash(Eina_Hash *hash,
826 int key_hash) EINA_ARG_NONNULL(1, 2); 826 int key_hash) EINA_ARG_NONNULL(1, 2);
827 827
828/** 828/**
829 * @brief Remove the entry identified by a key from the given hash table. 829 * @brief Removes the entry identified by a key from the given hash table.
830 * 830 *
831 * This version will calculate key length and hash by using functions 831 * This version will calculate key length and hash by using functions
832 * provided to hash creation function. 832 * provided to hash creation function.
@@ -837,21 +837,21 @@ EAPI Eina_Bool eina_hash_del_by_key_hash(Eina_Hash *hash,
837 * 837 *
838 * This function removes the entry identified by @p key from @p 838 * This function removes the entry identified by @p key from @p
839 * hash. The key length and hash will be calculated automatically by 839 * hash. The key length and hash will be calculated automatically by
840 * using functiond provided to has creation function. If a free 840 * using function provided to has creation function. If a free
841 * function was given to the callback on creation, it will be called 841 * function was given to the callback on creation, it will be called
842 * for the data being deleted. If @p hash or @p key are @c NULL, the 842 * for the data being deleted. If @p hash or @p key are @c NULL, the
843 * functions returns immediately #EINA_FALSE. This function 843 * functions returns immediately #EINA_FALSE. This function
844 * returns #EINA_FALSE if an error occurred, #EINA_TRUE otherwise. 844 * returns #EINA_FALSE if an error occurred, #EINA_TRUE otherwise.
845 * 845 *
846 * @note if you already have the key_hash, use eina_hash_del_by_key_hash() 846 * @note If you already have the key_hash, use eina_hash_del_by_key_hash()
847 * instead. 847 * instead.
848 * @note if you don't have the key, use eina_hash_del_by_data() instead. 848 * @note If you don't have the key, use eina_hash_del_by_data() instead.
849 */ 849 */
850EAPI Eina_Bool eina_hash_del_by_key(Eina_Hash *hash, 850EAPI Eina_Bool eina_hash_del_by_key(Eina_Hash *hash,
851 const void *key) EINA_ARG_NONNULL(1, 2); 851 const void *key) EINA_ARG_NONNULL(1, 2);
852 852
853/** 853/**
854 * @brief Remove the entry identified by a data from the given hash table. 854 * @brief Removes the entry identified by a data from the given hash table.
855 * 855 *
856 * This version is slow since there is no quick access to nodes based on data. 856 * This version is slow since there is no quick access to nodes based on data.
857 * 857 *
@@ -867,14 +867,14 @@ EAPI Eina_Bool eina_hash_del_by_key(Eina_Hash *hash,
867 * function returns #EINA_FALSE if an error occurred, #EINA_TRUE 867 * function returns #EINA_FALSE if an error occurred, #EINA_TRUE
868 * otherwise. 868 * otherwise.
869 * 869 *
870 * @note if you already have the key, use eina_hash_del_by_key() or 870 * @note If you already have the key, use eina_hash_del_by_key() or
871 * eina_hash_del_by_key_hash() instead. 871 * eina_hash_del_by_key_hash() instead.
872 */ 872 */
873EAPI Eina_Bool eina_hash_del_by_data(Eina_Hash *hash, 873EAPI Eina_Bool eina_hash_del_by_data(Eina_Hash *hash,
874 const void *data) EINA_ARG_NONNULL(1, 2); 874 const void *data) EINA_ARG_NONNULL(1, 2);
875 875
876/** 876/**
877 * @brief Remove the entry identified by a key and a key hash or a 877 * @brief Removes the entry identified by a key and a key hash or a
878 * data from the given hash table. 878 * data from the given hash table.
879 * 879 *
880 * If @p key is @c NULL, then @p data is used to find a match to 880 * If @p key is @c NULL, then @p data is used to find a match to
@@ -898,8 +898,8 @@ EAPI Eina_Bool eina_hash_del_by_data(Eina_Hash *hash,
898 * string when setting the value of @p key_length. This function 898 * string when setting the value of @p key_length. This function
899 * returns #EINA_FALSE if an error occurred, #EINA_TRUE otherwise. 899 * returns #EINA_FALSE if an error occurred, #EINA_TRUE otherwise.
900 * 900 *
901 * @note if you know you already have the key, use eina_hash_del_by_key_hash(), 901 * @note If you know you already have the key, use eina_hash_del_by_key_hash(),
902 * if you know you don't have the key, use eina_hash_del_by_data() 902 * If you know you don't have the key, use eina_hash_del_by_data()
903 * directly. 903 * directly.
904 */ 904 */
905EAPI Eina_Bool eina_hash_del_by_hash(Eina_Hash *hash, 905EAPI Eina_Bool eina_hash_del_by_hash(Eina_Hash *hash,
@@ -909,7 +909,7 @@ EAPI Eina_Bool eina_hash_del_by_hash(Eina_Hash *hash,
909 const void *data) EINA_ARG_NONNULL(1); 909 const void *data) EINA_ARG_NONNULL(1);
910 910
911/** 911/**
912 * @brief Retrieve a specific entry in the given hash table. 912 * @brief Retrieves a specific entry in the given hash table.
913 * 913 *
914 * @param hash The given hash table. Cannot be @c NULL. 914 * @param hash The given hash table. Cannot be @c NULL.
915 * @param key The key of the entry to find. 915 * @param key The key of the entry to find.
@@ -931,7 +931,7 @@ EAPI void *eina_hash_find_by_hash(const Eina_Hash *hash,
931 int key_hash) EINA_ARG_NONNULL(1, 2); 931 int key_hash) EINA_ARG_NONNULL(1, 2);
932 932
933/** 933/**
934 * @brief Modify the entry pointer at the specified key and returns 934 * @brief Modifies the entry pointer at the specified key and returns
935 * the old entry. 935 * the old entry.
936 * 936 *
937 * @param hash The given hash table. 937 * @param hash The given hash table.
@@ -952,7 +952,7 @@ EAPI void *eina_hash_modify_by_hash(Eina_Hash *hash,
952 const void *data) EINA_ARG_NONNULL(1, 2, 5); 952 const void *data) EINA_ARG_NONNULL(1, 2, 5);
953 953
954/** 954/**
955 * @brief Returned a new iterator associated to hash keys. 955 * @brief Returns a new iterator associated to hash keys.
956 * 956 *
957 * @param hash The hash. 957 * @param hash The hash.
958 * @return A new iterator. 958 * @return A new iterator.
@@ -972,7 +972,7 @@ EAPI void *eina_hash_modify_by_hash(Eina_Hash *hash,
972EAPI Eina_Iterator *eina_hash_iterator_key_new(const Eina_Hash *hash) EINA_MALLOC EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; 972EAPI Eina_Iterator *eina_hash_iterator_key_new(const Eina_Hash *hash) EINA_MALLOC EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
973 973
974/** 974/**
975 * @brief Returned a new iterator associated to hash data. 975 * @brief Returns a new iterator associated to hash data.
976 * 976 *
977 * @param hash The hash. 977 * @param hash The hash.
978 * @return A new iterator. 978 * @return A new iterator.
@@ -1005,7 +1005,7 @@ EAPI Eina_Iterator *eina_hash_iterator_data_new(const Eina_Hash *hash) EINA_MALL
1005 * If the memory can not be allocated, @c NULL is returned. 1005 * If the memory can not be allocated, @c NULL is returned.
1006 * Otherwise, a valid iterator is returned. 1006 * Otherwise, a valid iterator is returned.
1007 * 1007 *
1008 * @note iterator data will provide values as Eina_Hash_Tuple that should not 1008 * @note Iterator data will provide values as Eina_Hash_Tuple that should not
1009 * be modified! 1009 * be modified!
1010 * 1010 *
1011 * @warning if the hash structure changes then the iterator becomes 1011 * @warning if the hash structure changes then the iterator becomes
@@ -1015,7 +1015,7 @@ EAPI Eina_Iterator *eina_hash_iterator_data_new(const Eina_Hash *hash) EINA_MALL
1015EAPI Eina_Iterator *eina_hash_iterator_tuple_new(const Eina_Hash *hash) EINA_MALLOC EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; 1015EAPI Eina_Iterator *eina_hash_iterator_tuple_new(const Eina_Hash *hash) EINA_MALLOC EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
1016 1016
1017/** 1017/**
1018 * @brief Call a function on every member stored in the hash table 1018 * @brief Calls a function on every member stored in the hash table.
1019 * 1019 *
1020 * @param hash The hash table whose members will be walked 1020 * @param hash The hash table whose members will be walked
1021 * @param func The function to call on each parameter 1021 * @param func The function to call on each parameter
@@ -1055,7 +1055,7 @@ EAPI void eina_hash_foreach(const Eina_Hash *hash,
1055 1055
1056 1056
1057/** 1057/**
1058 * @brief Append data to an #Eina_List inside a hash 1058 * @brief Appends data to an #Eina_List inside a hash.
1059 * 1059 *
1060 * This function is identical to the sequence of calling 1060 * This function is identical to the sequence of calling
1061 * eina_hash_find(), eina_list_append(), eina_hash_set(), 1061 * eina_hash_find(), eina_list_append(), eina_hash_set(),
@@ -1067,7 +1067,7 @@ EAPI void eina_hash_foreach(const Eina_Hash *hash,
1067 */ 1067 */
1068EAPI void eina_hash_list_append(Eina_Hash *hash, const void *key, const void *data) EINA_ARG_NONNULL(1, 2, 3); 1068EAPI void eina_hash_list_append(Eina_Hash *hash, const void *key, const void *data) EINA_ARG_NONNULL(1, 2, 3);
1069/** 1069/**
1070 * @brief Prepend data to an #Eina_List inside a hash 1070 * @brief Prepends data to an #Eina_List inside a hash.
1071 * 1071 *
1072 * This function is identical to the sequence of calling 1072 * This function is identical to the sequence of calling
1073 * eina_hash_find(), eina_list_prepend(), eina_hash_set(), 1073 * eina_hash_find(), eina_list_prepend(), eina_hash_set(),
@@ -1079,7 +1079,7 @@ EAPI void eina_hash_list_append(Eina_Hash *hash, const void *key, const void *da
1079 */ 1079 */
1080EAPI void eina_hash_list_prepend(Eina_Hash *hash, const void *key, const void *data) EINA_ARG_NONNULL(1, 2, 3); 1080EAPI void eina_hash_list_prepend(Eina_Hash *hash, const void *key, const void *data) EINA_ARG_NONNULL(1, 2, 3);
1081/** 1081/**
1082 * @brief Remove data from an #Eina_List inside a hash 1082 * @brief Removes data from an #Eina_List inside a hash.
1083 * 1083 *
1084 * This function is identical to the sequence of calling 1084 * This function is identical to the sequence of calling
1085 * eina_hash_find(), eina_list_remove(), eina_hash_set(), 1085 * eina_hash_find(), eina_list_remove(), eina_hash_set(),
diff --git a/src/lib/eina/eina_inarray.h b/src/lib/eina/eina_inarray.h
index 2f95665049..7bba977a5b 100644
--- a/src/lib/eina/eina_inarray.h
+++ b/src/lib/eina/eina_inarray.h
@@ -166,7 +166,7 @@
166 * 166 *
167 * We then add element using eina_inarray_insert and print. Then remove that 167 * We then add element using eina_inarray_insert and print. Then remove that
168 * element and add again using eina_inarray_insert_sorted and prints. This 168 * element and add again using eina_inarray_insert_sorted and prints. This
169 * shows the 2 different positions the elment gets added. Then searches an 169 * shows the 2 different positions the element gets added. Then searches an
170 * element in the unsorted array using eina_inarray_search, then sorts the 170 * element in the unsorted array using eina_inarray_search, then sorts the
171 * array and then searches the same element using eina_inarray_search_sorted. 171 * array and then searches the same element using eina_inarray_search_sorted.
172 * @until } 172 * @until }
@@ -236,15 +236,14 @@ struct _Eina_Inarray
236 236
237/** 237/**
238 * @brief Creates a new inline array. 238 * @brief Creates a new inline array.
239 * @details This creates a new array where members are inlined in a sequence. Each
240 * member has @a member_size bytes.
239 * 241 *
240 * @param[in] member_size The size of each member in the array 242 * @param[in] member_size The size of each member in the array
241 * @param[in] step The step size by which to resize the array, do this using the following 243 * @param[in] step The step size by which to resize the array, do this using the following
242 * extra amount 244 * extra amount
243 * @return The new inline array table, otherwise @c NULL on failure 245 * @return The new inline array table, otherwise @c NULL on failure
244 * 246 *
245 * @details This creates a new array where members are inlined in a sequence. Each
246 * member has @a member_size bytes.
247 *
248 * @note If the @a step is @c 0, then a safe default is chosen. 247 * @note If the @a step is @c 0, then a safe default is chosen.
249 * 248 *
250 * @note On failure, @c NULL is returned. If @p member_size is zero, then @c NULL is returned. 249 * @note On failure, @c NULL is returned. If @p member_size is zero, then @c NULL is returned.
@@ -269,6 +268,8 @@ EAPI void eina_inarray_free(Eina_Inarray *array) EINA_ARG_NONNULL(1);
269 268
270/** 269/**
271 * @brief Initializes an inline array. 270 * @brief Initializes an inline array.
271 * @details This initializes an array. If the @p step is @c 0, then a safe default is
272 * chosen.
272 * 273 *
273 * @param[in] array The array object to initialize 274 * @param[in] array The array object to initialize
274 * @param[in] sizeof_eina_inarray The size of array object 275 * @param[in] sizeof_eina_inarray The size of array object
@@ -276,9 +277,6 @@ EAPI void eina_inarray_free(Eina_Inarray *array) EINA_ARG_NONNULL(1);
276 * @param[in] step The step size by which to resize the array, do this using the following 277 * @param[in] step The step size by which to resize the array, do this using the following
277 * extra amount 278 * extra amount
278 * 279 *
279 * @details This initializes an array. If the @p step is @c 0, then a safe default is
280 * chosen.
281 *
282 * @note This is useful for arrays inlined into other structures or 280 * @note This is useful for arrays inlined into other structures or
283 * allocated to a stack. 281 * allocated to a stack.
284 * 282 *
@@ -294,7 +292,6 @@ EAPI void eina_inarray_step_set(Eina_Inarray *array,
294/** 292/**
295 * @brief Removes every member from the array. 293 * @brief Removes every member from the array.
296 * 294 *
297 *
298 * @param[in] array The array object 295 * @param[in] array The array object
299 * 296 *
300 * @since 1.2 297 * @since 1.2
@@ -303,15 +300,14 @@ EAPI void eina_inarray_flush(Eina_Inarray *array) EINA_ARG_NONNULL(1);
303 300
304/** 301/**
305 * @brief Copies the data as the last member of the array. 302 * @brief Copies the data as the last member of the array.
303 * @details This copies the given pointer contents at the end of the array. The
304 * pointer is not referenced, instead its contents are copied to the
305 * members array using the previously defined @c member_size.
306 * 306 *
307 * @param[in] array The array object 307 * @param[in] array The array object
308 * @param[in] data The data to be copied at the end 308 * @param[in] data The data to be copied at the end
309 * @return The index of the new member, otherwise @c -1 on errors 309 * @return The index of the new member, otherwise @c -1 on errors
310 * 310 *
311 * @details This copies the given pointer contents at the end of the array. The
312 * pointer is not referenced, instead its contents are copied to the
313 * members array using the previously defined @c member_size.
314 *
315 * @see eina_inarray_insert_at() 311 * @see eina_inarray_insert_at()
316 * 312 *
317 * @since 1.2 313 * @since 1.2
@@ -320,7 +316,7 @@ EAPI int eina_inarray_push(Eina_Inarray *array,
320 const void *data) EINA_ARG_NONNULL(1, 2); 316 const void *data) EINA_ARG_NONNULL(1, 2);
321 317
322/** 318/**
323 * @brief Allocate new item at the end of the array. 319 * @brief Allocates new item at the end of the array.
324 * 320 *
325 * @param[in] array The array object 321 * @param[in] array The array object
326 * @param[in] size The number of new item to allocate 322 * @param[in] size The number of new item to allocate
@@ -334,17 +330,16 @@ EAPI void *eina_inarray_grow(Eina_Inarray *array, unsigned int size);
334 330
335/** 331/**
336 * @brief Copies the data to the array at a position found by the comparison function. 332 * @brief Copies the data to the array at a position found by the comparison function.
333 * @details This copies the given pointer contents at the array position defined by the
334 * given @a compare function. The pointer is not referenced, instead
335 * its contents are copied to the members array using the previously
336 * defined @c member_size.
337 * 337 *
338 * @param[in] array The array object 338 * @param[in] array The array object
339 * @param[in] data The data to be copied 339 * @param[in] data The data to be copied
340 * @param[in] compare The compare function 340 * @param[in] compare The compare function
341 * @return The index of the new member, otherwise @c -1 on errors 341 * @return The index of the new member, otherwise @c -1 on errors
342 * 342 *
343 * @details This copies the given pointer contents at the array position defined by the
344 * given @a compare function. The pointer is not referenced, instead
345 * its contents are copied to the members array using the previously
346 * defined @c member_size.
347 *
348 * @note The data given to the @p compare function is a pointer to the member 343 * @note The data given to the @p compare function is a pointer to the member
349 * memory itself, do no change it. 344 * memory itself, do no change it.
350 * 345 *
@@ -360,17 +355,16 @@ EAPI int eina_inarray_insert(Eina_Inarray *array,
360 355
361/** 356/**
362 * @brief Copies the data to the array at a position found by the comparison function. 357 * @brief Copies the data to the array at a position found by the comparison function.
358 * @details This copies the given pointer contents at the array position defined by the
359 * given @p compare function. The pointer is not referenced, instead
360 * its contents are copied to the members array using the previously
361 * defined @p member_size.
363 * 362 *
364 * @param[in] array The array object 363 * @param[in] array The array object
365 * @param[in] data The data to be copied 364 * @param[in] data The data to be copied
366 * @param[in] compare The compare function 365 * @param[in] compare The compare function
367 * @return The index of the new member, otherwise @c -1 on errors 366 * @return The index of the new member, otherwise @c -1 on errors
368 * 367 *
369 * @details This copies the given pointer contents at the array position defined by the
370 * given @p compare function. The pointer is not referenced, instead
371 * its contents are copied to the members array using the previously
372 * defined @p member_size.
373 *
374 * @note The data given to the @p compare function is a pointer to the member 368 * @note The data given to the @p compare function is a pointer to the member
375 * memory itself, do no change it. 369 * memory itself, do no change it.
376 * 370 *
@@ -387,15 +381,14 @@ EAPI int eina_inarray_insert_sorted(Eina_Inarray *array,
387 381
388/** 382/**
389 * @brief Finds data and removes the matching member. 383 * @brief Finds data and removes the matching member.
384 * @details This finds data in the array and removes it. Data may be an existing
385 * member of the array (then optimized) or the contents are matched
386 * using memcmp().
390 * 387 *
391 * @param[in] array The array object 388 * @param[in] array The array object
392 * @param[in] data The data to be found and removed 389 * @param[in] data The data to be found and removed
393 * @return The index of the removed member, otherwise @c -1 on errors 390 * @return The index of the removed member, otherwise @c -1 on errors
394 * 391 *
395 * @details This finds data in the array and removes it. Data may be an existing
396 * member of the array (then optimized) or the contents are matched
397 * using memcmp().
398 *
399 * @see eina_inarray_pop() 392 * @see eina_inarray_pop()
400 * @see eina_inarray_remove_at() 393 * @see eina_inarray_remove_at()
401 * 394 *
@@ -418,16 +411,15 @@ EAPI void *eina_inarray_pop(Eina_Inarray *array) EINA_ARG_NONNULL(1);
418 411
419/** 412/**
420 * @brief Gets the member at the given position. 413 * @brief Gets the member at the given position.
421 *
422 * @param[in] array The array object
423 * @param[in] position The member position
424 * @return A pointer to current the member memory
425 *
426 * @details This gets the member given that its position in the array is provided. It is a pointer to 414 * @details This gets the member given that its position in the array is provided. It is a pointer to
427 * its current memory, then it can be invalidated with functions that 415 * its current memory, then it can be invalidated with functions that
428 * change the array such as eina_inarray_push(), 416 * change the array such as eina_inarray_push(),
429 * eina_inarray_insert_at(), or eina_inarray_remove_at(), or variants. 417 * eina_inarray_insert_at(), or eina_inarray_remove_at(), or variants.
430 * 418 *
419 * @param[in] array The array object
420 * @param[in] position The member position
421 * @return A pointer to current the member memory
422 *
431 * @see eina_inarray_lookup() 423 * @see eina_inarray_lookup()
432 * @see eina_inarray_lookup_sorted() 424 * @see eina_inarray_lookup_sorted()
433 * 425 *
@@ -438,17 +430,16 @@ EAPI void *eina_inarray_nth(const Eina_Inarray *array,
438 430
439/** 431/**
440 * @brief Copies the data at the given position in the array. 432 * @brief Copies the data at the given position in the array.
433 * @details This copies the given pointer contents at the given @p position in the
434 * array. The pointer is not referenced, instead its contents are
435 * copied to the members array using the previously defined
436 * @p member_size.
441 * 437 *
442 * @param[in] array The array object 438 * @param[in] array The array object
443 * @param[in] position The position to insert the member at 439 * @param[in] position The position to insert the member at
444 * @param[in] data The data to be copied at the position 440 * @param[in] data The data to be copied at the position
445 * @return #EINA_TRUE on success, otherwise #EINA_FALSE on failure 441 * @return #EINA_TRUE on success, otherwise #EINA_FALSE on failure
446 * 442 *
447 * @details This copies the given pointer contents at the given @p position in the
448 * array. The pointer is not referenced, instead its contents are
449 * copied to the members array using the previously defined
450 * @p member_size.
451 *
452 * @note All the members from @a position to the end of the array are 443 * @note All the members from @a position to the end of the array are
453 * shifted to the end. 444 * shifted to the end.
454 * 445 *
@@ -495,17 +486,16 @@ EAPI void *eina_inarray_alloc_at(Eina_Inarray *array,
495 486
496/** 487/**
497 * @brief Copies the data to the given position. 488 * @brief Copies the data to the given position.
489 * @details This copies the given pointer contents at the given @p position in the
490 * array. The pointer is not referenced, instead its contents are
491 * copied to the members array using the previously defined
492 * @p member_size.
498 * 493 *
499 * @param[in] array The array object 494 * @param[in] array The array object
500 * @param[in] position The position to copy the member at 495 * @param[in] position The position to copy the member at
501 * @param[in] data The data to be copied at the position 496 * @param[in] data The data to be copied at the position
502 * @return #EINA_TRUE on success, otherwise #EINA_FALSE on failure 497 * @return #EINA_TRUE on success, otherwise #EINA_FALSE on failure
503 * 498 *
504 * @details This copies the given pointer contents at the given @p position in the
505 * array. The pointer is not referenced, instead its contents are
506 * copied to the members array using the previously defined
507 * @p member_size.
508 *
509 * @note If @p position does not exist, it fails. 499 * @note If @p position does not exist, it fails.
510 * 500 *
511 * @since 1.2 501 * @since 1.2
@@ -548,12 +538,11 @@ EAPI void eina_inarray_reverse(Eina_Inarray *array) EINA_ARG_NONNULL(1);
548 538
549/** 539/**
550 * @brief Applies a quick sort to the array. 540 * @brief Applies a quick sort to the array.
541 * @details This applies a quick sort to the @a array.
551 * 542 *
552 * @param[in] array The array object 543 * @param[in] array The array object
553 * @param[in] compare The compare function 544 * @param[in] compare The compare function
554 * 545 *
555 * @details This applies a quick sort to the @a array.
556 *
557 * @note The data given to the @a compare function is a pointer to the member 546 * @note The data given to the @a compare function is a pointer to the member
558 * memory itself, do no change it. 547 * memory itself, do no change it.
559 * 548 *
@@ -566,15 +555,14 @@ EAPI void eina_inarray_sort(Eina_Inarray *array,
566 555
567/** 556/**
568 * @brief Searches for a member (linear walk). 557 * @brief Searches for a member (linear walk).
558 * @details This walks through an array by linearly looking for the given data compared by
559 * the @p compare function.
569 * 560 *
570 * @param[in] array The array object 561 * @param[in] array The array object
571 * @param[in] data The member to search using the @p compare function 562 * @param[in] data The member to search using the @p compare function
572 * @param[in] compare The compare function 563 * @param[in] compare The compare function
573 * @return The member index, otherwise @c -1 if not found 564 * @return The member index, otherwise @c -1 if not found
574 * 565 *
575 * @details This walks through an array by linearly looking for the given data compared by
576 * the @p compare function.
577 *
578 * @note The data given to the @p compare function is a pointer to the member 566 * @note The data given to the @p compare function is a pointer to the member
579 * memory itself, do no change it. 567 * memory itself, do no change it.
580 * 568 *
@@ -607,14 +595,13 @@ EAPI int eina_inarray_search_sorted(const Eina_Inarray *array,
607 595
608/** 596/**
609 * @brief Calls @p function for each array member. 597 * @brief Calls @p function for each array member.
598 * @details This calls @p function for every given data in @p array.
610 * 599 *
611 * @param[in] array The array object 600 * @param[in] array The array object
612 * @param[in] function The callback function 601 * @param[in] function The callback function
613 * @param[in] user_data The user data given to a callback @a function 602 * @param[in] user_data The user data given to a callback @a function
614 * @return #EINA_TRUE if it successfully iterates all the items of the array 603 * @return #EINA_TRUE if it successfully iterates all the items of the array
615 * 604 *
616 * @details This calls @p function for every given data in @p array.
617 *
618 * @note This is a safe way to iterate over an array. @p function should return #EINA_TRUE 605 * @note This is a safe way to iterate over an array. @p function should return #EINA_TRUE
619 * as long as you want the function to continue iterating, by 606 * as long as you want the function to continue iterating, by
620 * returning #EINA_FALSE it stops and returns #EINA_FALSE as the result. 607 * returning #EINA_FALSE it stops and returns #EINA_FALSE as the result.
@@ -631,15 +618,14 @@ EAPI Eina_Bool eina_inarray_foreach(const Eina_Inarray *array,
631 618
632/** 619/**
633 * @brief Removes all the members that match. 620 * @brief Removes all the members that match.
621 * @details This removes all the entries in @p array, where the @p match function
622 * returns #EINA_TRUE.
634 * 623 *
635 * @param[in] array The array object 624 * @param[in] array The array object
636 * @param[in] match The match function 625 * @param[in] match The match function
637 * @param[in] user_data The user data given to callback @p match 626 * @param[in] user_data The user data given to callback @p match
638 * @return The number of removed entries, otherwise @c -1 on error 627 * @return The number of removed entries, otherwise @c -1 on error
639 * 628 *
640 * @details This removes all the entries in @p array, where the @p match function
641 * returns #EINA_TRUE.
642 *
643 * @since 1.2 629 * @since 1.2
644 */ 630 */
645EAPI int eina_inarray_foreach_remove(Eina_Inarray *array, 631EAPI int eina_inarray_foreach_remove(Eina_Inarray *array,
@@ -669,13 +655,12 @@ EAPI unsigned int eina_inarray_count(const Eina_Inarray *array) EINA_ARG_NONNULL
669 655
670/** 656/**
671 * @brief Returns a new iterator associated to an array. 657 * @brief Returns a new iterator associated to an array.
658 * @details This function returns a newly allocated iterator associated to
659 * @p array.
672 * 660 *
673 * @param[in] array The array object 661 * @param[in] array The array object
674 * @return A new iterator 662 * @return A new iterator
675 * 663 *
676 * @details This function returns a newly allocated iterator associated to
677 * @p array.
678 *
679 * @note If the memory cannot be allocated, @c NULL is returned. 664 * @note If the memory cannot be allocated, @c NULL is returned.
680 * Otherwise, a valid iterator is returned. 665 * Otherwise, a valid iterator is returned.
681 * 666 *
@@ -689,13 +674,12 @@ EAPI Eina_Iterator *eina_inarray_iterator_new(const Eina_Inarray *array) EINA_MA
689 674
690/** 675/**
691 * @brief Returns a new reversed iterator associated to an array. 676 * @brief Returns a new reversed iterator associated to an array.
677 * @details This function returns a newly allocated iterator associated to
678 * @p array.
692 * 679 *
693 * @param[in] array The array object 680 * @param[in] array The array object
694 * @return A new iterator 681 * @return A new iterator
695 * 682 *
696 * @details This function returns a newly allocated iterator associated to
697 * @p array.
698 *
699 * @note Unlike eina_inarray_iterator_new(), this walks through the array backwards. 683 * @note Unlike eina_inarray_iterator_new(), this walks through the array backwards.
700 * 684 *
701 * @note If the memory cannot be allocated, @c NULL is returned. 685 * @note If the memory cannot be allocated, @c NULL is returned.
@@ -711,13 +695,12 @@ EAPI Eina_Iterator *eina_inarray_iterator_reversed_new(const Eina_Inarray *array
711 695
712/** 696/**
713 * @brief Returns a new accessor associated to an array. 697 * @brief Returns a new accessor associated to an array.
698 * @details This function returns a newly allocated accessor associated to
699 * @p array.
714 * 700 *
715 * @param[in] array The array object 701 * @param[in] array The array object
716 * @return A new accessor 702 * @return A new accessor
717 * 703 *
718 * @details This function returns a newly allocated accessor associated to
719 * @p array.
720 *
721 * @note If the memory cannot be allocated, @c NULL is returned 704 * @note If the memory cannot be allocated, @c NULL is returned
722 * Otherwise, a valid accessor is returned. 705 * Otherwise, a valid accessor is returned.
723 * 706 *
diff --git a/src/lib/eina/eina_inlist.h b/src/lib/eina/eina_inlist.h
index 243e651088..79a6c6ea0f 100644
--- a/src/lib/eina/eina_inlist.h
+++ b/src/lib/eina/eina_inlist.h
@@ -420,9 +420,9 @@ struct _Eina_Inlist
420 420
421 421
422/** 422/**
423 * Add a new node to end of a list. 423 * @brief Adds a new node to end of a list.
424 * 424 *
425 * @note this code is meant to be fast: appends are O(1) and do not 425 * @note This code is meant to be fast: appends are O(1) and do not
426 * walk @a in_list. 426 * walk @a in_list.
427 * 427 *
428 * @note @a in_item is considered to be in no list. If it was in another 428 * @note @a in_item is considered to be in no list. If it was in another
@@ -430,18 +430,18 @@ struct _Eina_Inlist
430 * check of @a new_l prev and next pointers is done, so it's safe 430 * check of @a new_l prev and next pointers is done, so it's safe
431 * to have them uninitialized. 431 * to have them uninitialized.
432 * 432 *
433 * @param in_list existing list head or @c NULL to create a new list. 433 * @param in_list Existing list head or @c NULL to create a new list.
434 * @param in_item new list node, must not be @c NULL. 434 * @param in_item New list node, must not be @c NULL.
435 * 435 *
436 * @return the new list head. Use it and not @a in_list anymore. 436 * @return The new list head. Use it and not @a in_list anymore.
437 */ 437 */
438EAPI Eina_Inlist *eina_inlist_append(Eina_Inlist *in_list, 438EAPI Eina_Inlist *eina_inlist_append(Eina_Inlist *in_list,
439 Eina_Inlist *in_item) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT; 439 Eina_Inlist *in_item) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT;
440 440
441/** 441/**
442 * Add a new node to beginning of list. 442 * @brief Adds a new node to beginning of list.
443 * 443 *
444 * @note this code is meant to be fast: appends are O(1) and do not 444 * @note This code is meant to be fast: appends are O(1) and do not
445 * walk @a in_list. 445 * walk @a in_list.
446 * 446 *
447 * @note @a new_l is considered to be in no list. If it was in another 447 * @note @a new_l is considered to be in no list. If it was in another
@@ -449,18 +449,18 @@ EAPI Eina_Inlist *eina_inlist_append(Eina_Inlist *in_list,
449 * check of @a new_l prev and next pointers is done, so it's safe 449 * check of @a new_l prev and next pointers is done, so it's safe
450 * to have them uninitialized. 450 * to have them uninitialized.
451 * 451 *
452 * @param in_list existing list head or @c NULL to create a new list. 452 * @param in_list Existing list head or @c NULL to create a new list.
453 * @param in_item new list node, must not be @c NULL. 453 * @param in_item New list node, must not be @c NULL.
454 * 454 *
455 * @return the new list head. Use it and not @a in_list anymore. 455 * @return The new list head. Use it and not @a in_list anymore.
456 */ 456 */
457EAPI Eina_Inlist *eina_inlist_prepend(Eina_Inlist *in_list, 457EAPI Eina_Inlist *eina_inlist_prepend(Eina_Inlist *in_list,
458 Eina_Inlist *in_item) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT; 458 Eina_Inlist *in_item) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT;
459 459
460/** 460/**
461 * Add a new node after the given relative item in list. 461 * @brief Adds a new node after the given relative item in list.
462 * 462 *
463 * @note this code is meant to be fast: appends are O(1) and do not 463 * @note This code is meant to be fast: appends are O(1) and do not
464 * walk @a in_list. 464 * walk @a in_list.
465 * 465 *
466 * @note @a in_item_l is considered to be in no list. If it was in another 466 * @note @a in_item_l is considered to be in no list. If it was in another
@@ -473,20 +473,20 @@ EAPI Eina_Inlist *eina_inlist_prepend(Eina_Inlist *in_list,
473 * will lead to problems. Giving NULL @a in_relative is the same as 473 * will lead to problems. Giving NULL @a in_relative is the same as
474 * eina_list_append(). 474 * eina_list_append().
475 * 475 *
476 * @param in_list existing list head or @c NULL to create a new list. 476 * @param in_list Existing list head or @c NULL to create a new list.
477 * @param in_item new list node, must not be @c NULL. 477 * @param in_item New list node, must not be @c NULL.
478 * @param in_relative reference node, @a in_item will be added after it. 478 * @param in_relative Reference node, @a in_item will be added after it.
479 * 479 *
480 * @return the new list head. Use it and not @a list anymore. 480 * @return The new list head. Use it and not @a list anymore.
481 */ 481 */
482EAPI Eina_Inlist *eina_inlist_append_relative(Eina_Inlist *in_list, 482EAPI Eina_Inlist *eina_inlist_append_relative(Eina_Inlist *in_list,
483 Eina_Inlist *in_item, 483 Eina_Inlist *in_item,
484 Eina_Inlist *in_relative) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT; 484 Eina_Inlist *in_relative) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT;
485 485
486/** 486/**
487 * Add a new node before the given relative item in list. 487 * @brief Adds a new node before the given relative item in list.
488 * 488 *
489 * @note this code is meant to be fast: appends are O(1) and do not 489 * @note This code is meant to be fast: appends are O(1) and do not
490 * walk @a in_list. 490 * walk @a in_list.
491 * 491 *
492 * @note @a in_item is considered to be in no list. If it was in another 492 * @note @a in_item is considered to be in no list. If it was in another
@@ -499,20 +499,20 @@ EAPI Eina_Inlist *eina_inlist_append_relative(Eina_Inlist *in_list,
499 * will lead to problems. Giving NULL @a in_relative is the same as 499 * will lead to problems. Giving NULL @a in_relative is the same as
500 * eina_list_prepend(). 500 * eina_list_prepend().
501 * 501 *
502 * @param in_list existing list head or @c NULL to create a new list. 502 * @param in_list Existing list head or @c NULL to create a new list.
503 * @param in_item new list node, must not be @c NULL. 503 * @param in_item New list node, must not be @c NULL.
504 * @param in_relative reference node, @a in_item will be added before it. 504 * @param in_relative Reference node, @a in_item will be added before it.
505 * 505 *
506 * @return the new list head. Use it and not @a in_list anymore. 506 * @return The new list head. Use it and not @a in_list anymore.
507 */ 507 */
508EAPI Eina_Inlist *eina_inlist_prepend_relative(Eina_Inlist *in_list, 508EAPI Eina_Inlist *eina_inlist_prepend_relative(Eina_Inlist *in_list,
509 Eina_Inlist *in_item, 509 Eina_Inlist *in_item,
510 Eina_Inlist *in_relative) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT; 510 Eina_Inlist *in_relative) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT;
511 511
512/** 512/**
513 * Remove node from list. 513 * @brief Removes node from list.
514 * 514 *
515 * @note this code is meant to be fast: appends are O(1) and do not 515 * @note This code is meant to be fast: appends are O(1) and do not
516 * walk @a list. 516 * walk @a list.
517 * 517 *
518 * @note @a in_item is considered to be inside @a in_list, no checks are 518 * @note @a in_item is considered to be inside @a in_list, no checks are
@@ -521,22 +521,22 @@ EAPI Eina_Inlist *eina_inlist_prepend_relative(Eina_Inlist *in_list,
521 * it will be different from @a list and the wrong new head will 521 * it will be different from @a list and the wrong new head will
522 * be returned. 522 * be returned.
523 * 523 *
524 * @param in_list existing list head, must not be @c NULL. 524 * @param in_list Existing list head, must not be @c NULL.
525 * @param in_item existing list node, must not be @c NULL. 525 * @param in_item Existing list node, must not be @c NULL.
526 * 526 *
527 * @return the new list head. Use it and not @a list anymore. 527 * @return The new list head. Use it and not @a list anymore.
528 */ 528 */
529EAPI Eina_Inlist *eina_inlist_remove(Eina_Inlist *in_list, 529EAPI Eina_Inlist *eina_inlist_remove(Eina_Inlist *in_list,
530 Eina_Inlist *in_item) EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT; 530 Eina_Inlist *in_item) EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT;
531 531