cedric pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=6ccc7448e705f1dcf32c5483a55bcc9ced5a5041
commit 6ccc7448e705f1dcf32c5483a55bcc9ced5a5041 Author: Bryce Harrington <[email protected]> Date: Mon Mar 26 16:03:42 2018 -0700 eina: Add Doxygen in/out indicators to matrixsparse, clist, and array Reviewers: cedric Reviewed By: cedric Subscribers: cedric Differential Revision: https://phab.enlightenment.org/D5849 Reviewed-by: Cedric BAIL <[email protected]> --- src/lib/eina/eina_array.h | 59 ++++++++++++------------ src/lib/eina/eina_clist.h | 82 ++++++++++++++++----------------- src/lib/eina/eina_matrixsparse.h | 99 ++++++++++++++++++++-------------------- 3 files changed, 121 insertions(+), 119 deletions(-) diff --git a/src/lib/eina/eina_array.h b/src/lib/eina/eina_array.h index 823f824958..20ee31fdcc 100644 --- a/src/lib/eina/eina_array.h +++ b/src/lib/eina/eina_array.h @@ -244,7 +244,7 @@ struct _Eina_Array /** * @brief Creates a new array. * - * @param step The count of pointers to add when increasing the array size. + * @param[in] step The count of pointers to add when increasing the array size. * @return @c NULL on failure, non @c NULL otherwise. * * This function creates a new array. When adding an element, the array @@ -259,7 +259,7 @@ EAPI Eina_Array *eina_array_new(unsigned int step) EINA_WARN_UNUSED_RESULT EINA_ /** * @brief Frees an array. * - * @param array The array to free. + * @param[in] array The array to free. * * This function frees @p array. It calls first eina_array_flush() then * frees the memory of the pointer. It does not free the memory @@ -271,9 +271,9 @@ EAPI void eina_array_free(Eina_Array *array); /** * @brief Sets the step of an array. * - * @param array The array. - * @param sizeof_eina_array Should be the value returned by sizeof(Eina_Array). - * @param step The count of pointers to add when increasing the array size. + * @param[in,out] array The array. + * @param[in] sizeof_eina_array Should be the value returned by sizeof(Eina_Array). + * @param[in] step The count of pointers to add when increasing the array size. * * This function sets the step of @p array to @p step. For performance * reasons, there is no check of @p array. If it is @c NULL or @@ -287,7 +287,7 @@ EAPI void eina_array_step_set(Eina_Array *array, /** * @brief Cleans an array. * - * @param array The array to clean. + * @param[in,out] array The array to clean. * * This function sets the count member of @p array to 0, however it doesn't free * any space. This is particularly useful if you need to empty the array and @@ -299,7 +299,7 @@ static inline void eina_array_clean(Eina_Array *array) EINA_ARG_NONNULL(1); /** * @brief Flushes an array. * - * @param array The array to flush. + * @param[in,out] array The array to flush. * * This function sets the count and total members of @p array to 0, * frees and set to NULL its data member. For performance reasons, @@ -311,9 +311,9 @@ EAPI void eina_array_flush(Eina_Array *array) EINA_ARG_NONNULL(1); /** * @brief Rebuilds an array by specifying the data to keep. * - * @param array The array. - * @param keep The functions which selects the data to keep. - * @param gdata The data to pass to the function keep. + * @param[in,out] array The array. + * @param[in] keep The functions which selects the data to keep. + * @param[in] gdata The data to pass to the function keep. * @return #EINA_TRUE on success, #EINA_FALSE otherwise. * * This function rebuilds @p array by specifying the elements to keep with the @@ -331,8 +331,8 @@ EAPI Eina_Bool eina_array_remove(Eina_Array * array, /** * @brief Appends a data to an array. * - * @param array The array. - * @param data The data to add. + * @param[in,out] array The array. + * @param[in] data The data to add. * @return #EINA_TRUE on success, #EINA_FALSE otherwise. * * This function appends @p data to @p array. For performance @@ -347,7 +347,7 @@ static inline Eina_Bool eina_array_push(Eina_Array *array, /** * @brief Removes the last data of an array. * - * @param array The array. + * @param[in,out] array The array. * @return The retrieved data. * * This function removes the last data of @p array, decreases the count @@ -361,8 +361,8 @@ static inline void *eina_array_pop(Eina_Array *array) EINA_ARG_NONNULL(1); /** * @brief Returns the data at a given position in an array. * - * @param array The array. - * @param idx The position of the data to retrieve. + * @param[in] array The array. + * @param[in] idx The position of the data to retrieve. * @return The retrieved data. * * This function returns the data at the position @p idx in @p @@ -374,9 +374,9 @@ static inline void *eina_array_data_get(const Eina_Array *array, /** * @brief Sets the data at a given position in an array. * - * @param array The array. - * @param idx The position of the data to set. - * @param data The data to set. + * @param[in] array The array. + * @param[in] idx The position of the data to set. + * @param[in] data The data to set. * * This function sets the data at the position @p idx in @p * array to @p data, this effectively replaces the previously held data, you @@ -391,7 +391,7 @@ static inline void eina_array_data_set(const Eina_Array *array, * @deprecated use eina_array_count() * @brief Returns the number of elements in an array. * - * @param array The array. + * @param[in] array The array. * @return The number of elements. * * This function returns the number of elements in @p array (array->count). For @@ -404,7 +404,7 @@ static inline unsigned int eina_array_count_get(const Eina_Array *array) EINA_AR /** * @brief Returns the number of elements in an array. * - * @param array The array. + * @param[in] array The array. * @return The number of elements. * * This function returns the number of elements in @p array (array->count). For @@ -416,7 +416,7 @@ static inline unsigned int eina_array_count(const Eina_Array *array) EINA_ARG_NO /** * @brief Gets a new iterator associated with an array. * - * @param array The array. + * @param[in] array The array. * @return A new iterator. * * This function returns a newly allocated iterator associated to @@ -429,7 +429,7 @@ EAPI Eina_Iterator *eina_array_iterator_new(const Eina_Array *array) EINA /** * @brief Gets a new accessor associated with an array. * - * @param array The array. + * @param[in] array The array. * @return A new accessor. * * This function returns a newly allocated accessor associated to @@ -439,12 +439,13 @@ EAPI Eina_Iterator *eina_array_iterator_new(const Eina_Array *array) EINA * returned. */ EAPI Eina_Accessor *eina_array_accessor_new(const Eina_Array *array) EINA_MALLOC EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; + /** * @brief Provides a safe way to iterate over an array. * - * @param array The array to iterate over. - * @param cb The callback to call for each item. - * @param fdata The user data to pass to the callback. + * @param[in] array The array to iterate over. + * @param[in] cb The callback to call for each item. + * @param[in] fdata The user data to pass to the callback. * @return #EINA_TRUE if it successfully iterated all items of the array. * * This function provides a safe way to iterate over an array. @p cb should @@ -459,10 +460,10 @@ static inline Eina_Bool eina_array_foreach(Eina_Array *array, * @def EINA_ARRAY_ITER_NEXT * @brief Definition for the macro to iterate over an array easily. * - * @param array The array to iterate over. - * @param index The integer number that is increased while iterating. - * @param item The data - * @param iterator The iterator + * @param[in] array The array to iterate over. + * @param[out] index The integer number that is increased while iterating. + * @param[out] item The data + * @param[in,out] iterator The iterator * * This macro allows the iteration over @p array in an easy way. It * iterates from the first element to the last one. @p index is an diff --git a/src/lib/eina/eina_clist.h b/src/lib/eina/eina_clist.h index e927a9bc25..8f78a1e83c 100644 --- a/src/lib/eina/eina_clist.h +++ b/src/lib/eina/eina_clist.h @@ -114,7 +114,7 @@ struct _Eina_Clist /** * @brief Adds an element after the specified one. * - * @param[in] elem An element in the list + * @param[in,out] elem An element in the list * @param[in] to_add The element to add to the list * @pre The list head must be initialized once before adding anything. * @pre The element is not in any list. @@ -128,7 +128,7 @@ static inline void eina_clist_add_after(Eina_Clist *elem, Eina_Clist *to_add); /** * @brief Adds an element before the specified one. * - * @param[in] elem An element in the list + * @param[in,out] elem An element in the list * @param[in] to_add The element to add to the list * @pre The list head must be initialized once before adding anything. * @pre The element is not in any list. @@ -142,7 +142,7 @@ static inline void eina_clist_add_before(Eina_Clist *elem, Eina_Clist *to_add); /** * @brief Adds an element to the head of the list. * - * @param[in] list The list + * @param[in,out] list The list * @param[in] elem An element * @pre The list head must be initialized once before adding anything. * @pre The element is not in any list. @@ -156,7 +156,7 @@ static inline void eina_clist_add_head(Eina_Clist *list, Eina_Clist *elem); /** * @brief Adds an element at the tail of the list. * - * @param[in] list The list + * @param[in,out] list The list * @param[in] elem An element * @pre The list head must be initialized once before adding anything. * @pre The element is not in any list. @@ -172,7 +172,7 @@ static inline void eina_clist_add_tail(Eina_Clist *list, Eina_Clist *elem); * @details This function is called on elements that have not been added to the list * so that eina_clist_element_init() works correctly. * - * @param[in] elem An element + * @param[in,out] elem An element * @pre The element is not in any list. * @post The element is marked as not being in any list. * @@ -197,7 +197,7 @@ static inline int eina_clist_element_is_linked(Eina_Clist *elem); /** * @brief Removes an element from its list. * - * @param[in] elem An element + * @param[in,out] elem An element * @pre The element is already in a list. * @post The element is marked as not being in any list. * @@ -262,7 +262,7 @@ static inline int eina_clist_empty(const Eina_Clist *list); /** * @brief Initializes a list. * - * @param[in] list The list + * @param[in,out] list The list * @pre The list is uninitialized * @post The list contains no items * @@ -287,7 +287,7 @@ static inline unsigned int eina_clist_count(const Eina_Clist *list); /** * @brief Moves all elements from @p src to the tail of @p dst. * - * @param[in] dst The list to be appended to + * @param[in,out] dst The list to be appended to * @param[in] src The list to append * * @post @p src is initialized, but is empty after this operation. @@ -299,7 +299,7 @@ static inline void eina_clist_move_tail(Eina_Clist *dst, Eina_Clist *src); /** * @brief Moves all elements from @p src to the head of @p dst. * - * @param[in] dst The list to be prepended to + * @param[in,out] dst The list to be prepended to * @param[in] src The list to prepend * * @post @p src is initialized, but is empty after this operation. @@ -312,8 +312,8 @@ static inline void eina_clist_move_head(Eina_Clist *dst, Eina_Clist *src); * @def EINA_CLIST_FOR_EACH * @brief Iterates through the list. * - * @param cursor The pointer to be used during the interaction - * @param list The list to be interacted with + * @param[out] cursor The pointer to be used during the interaction + * @param[in] list The list to be interacted with */ #define EINA_CLIST_FOR_EACH(cursor,list) \ for ((cursor) = (list)->next; (cursor) != (list); (cursor) = (cursor)->next) @@ -322,9 +322,9 @@ static inline void eina_clist_move_head(Eina_Clist *dst, Eina_Clist *src); * @def EINA_CLIST_FOR_EACH_SAFE * @brief Iterates through the list, with safety against removal. * - * @param cursor The pointer to be used during the interaction - * @param cursor2 The auxiliary pointer to be used during the interaction - * @param list The list to be interacted with + * @param[out] cursor The pointer to be used during the interaction + * @param[out] cursor2 The auxiliary pointer to be used during the interaction + * @param[in] list The list to be interacted with */ #define EINA_CLIST_FOR_EACH_SAFE(cursor, cursor2, list) \ for ((cursor) = (list)->next, (cursor2) = (cursor)->next; \ @@ -335,10 +335,10 @@ static inline void eina_clist_move_head(Eina_Clist *dst, Eina_Clist *src); * @def EINA_CLIST_FOR_EACH_ENTRY * @brief Iterates through the list using a list entry. * - * @param elem The element to be used - * @param list The list to be iterated - * @param type The type of the list - * @param field The field of the element + * @param[out] elem The element to be used + * @param[in] list The list to be iterated + * @param[in] type The type of the list + * @param[in] field The field of the element */ #define EINA_CLIST_FOR_EACH_ENTRY(elem, list, type, field) \ for ((elem) = EINA_CLIST_ENTRY((list)->next, type, field); \ @@ -349,11 +349,11 @@ static inline void eina_clist_move_head(Eina_Clist *dst, Eina_Clist *src); * @def EINA_CLIST_FOR_EACH_ENTRY_SAFE * @brief Iterates through the list using a list entry, with safety against removal. * - * @param cursor The pointer to be used during the interaction - * @param cursor2 The auxiliary pointer to be used during the interaction - * @param list The list to be interacted with - * @param type The type of the list - * @param field The field of the element + * @param[out] cursor The pointer to be used during the interaction + * @param[out] cursor2 The auxiliary pointer to be used during the interaction + * @param[in] list The list to be interacted with + * @param[in] type The type of the list + * @param[in] field The field of the element */ #define EINA_CLIST_FOR_EACH_ENTRY_SAFE(cursor, cursor2, list, type, field) \ for ((cursor) = EINA_CLIST_ENTRY((list)->next, type, field), \ @@ -366,8 +366,8 @@ static inline void eina_clist_move_head(Eina_Clist *dst, Eina_Clist *src); * @def EINA_CLIST_FOR_EACH_REV * @brief Iterates through the list in the reverse order. * - * @param cursor The pointer to be used during the interaction - * @param list The list to be interacted with + * @param[out] cursor The pointer to be used during the interaction + * @param[in] list The list to be interacted with */ #define EINA_CLIST_FOR_EACH_REV(cursor,list) \ for ((cursor) = (list)->prev; (cursor) != (list); (cursor) = (cursor)->prev) @@ -376,9 +376,9 @@ static inline void eina_clist_move_head(Eina_Clist *dst, Eina_Clist *src); * @def EINA_CLIST_FOR_EACH_SAFE_REV * @brief Iterates through the list in the reverse order, with safety against removal. * - * @param cursor The pointer to be used during the interaction - * @param cursor2 The auxiliary pointer to be used during the interaction - * @param list The list to be interacted with + * @param[out] cursor The pointer to be used during the interaction + * @param[out] cursor2 The auxiliary pointer to be used during the interaction + * @param[in] list The list to be interacted with */ #define EINA_CLIST_FOR_EACH_SAFE_REV(cursor, cursor2, list) \ for ((cursor) = (list)->prev, (cursor2) = (cursor)->prev; \ @@ -389,10 +389,10 @@ static inline void eina_clist_move_head(Eina_Clist *dst, Eina_Clist *src); * @def EINA_CLIST_FOR_EACH_ENTRY_REV * @brief Iterates through the list in the reverse order using a list entry. * - * @param elem The element to be used - * @param list The list to be iterated - * @param type The type of the list - * @param field The field of the element + * @param[out] elem The element to be used + * @param[in] list The list to be iterated + * @param[in] type The type of the list + * @param[in] field The field of the element */ #define EINA_CLIST_FOR_EACH_ENTRY_REV(elem, list, type, field) \ for ((elem) = EINA_CLIST_ENTRY((list)->prev, type, field); \ @@ -404,11 +404,11 @@ static inline void eina_clist_move_head(Eina_Clist *dst, Eina_Clist *src); * @brief Iterates through the list in the reverse order using a list entry, with safety against * removal. * - * @param cursor The pointer to be used during the interaction - * @param cursor2 The auxiliary pointer to be used during the interaction - * @param list The list to be interacted with - * @param type The type of the list - * @param field The field of the element + * @param[out] cursor The pointer to be used during the interaction + * @param[out] cursor2 The auxiliary pointer to be used during the interaction + * @param[in] list The list to be interacted with + * @param[in] type The type of the list + * @param[in] field The field of the element */ #define EINA_CLIST_FOR_EACH_ENTRY_SAFE_REV(cursor, cursor2, list, type, field) \ for ((cursor) = EINA_CLIST_ENTRY((list)->prev, type, field), \ @@ -421,7 +421,7 @@ static inline void eina_clist_move_head(Eina_Clist *dst, Eina_Clist *src); * @def EINA_CLIST_INIT * @brief Macros for statically initialized lists. * - * @param list The list to be used + * @param[in,out] list The list to be used */ #undef EINA_CLIST_INIT #define EINA_CLIST_INIT(list) { &(list), &(list) } @@ -430,9 +430,9 @@ static inline void eina_clist_move_head(Eina_Clist *dst, Eina_Clist *src); * @def EINA_CLIST_ENTRY * @brief Gets a pointer to the object containing the list element. * - * @param elem The element to be used - * @param type The type of the element - * @param field The field of the element + * @param[out] elem The element to be used + * @param[in] type The type of the element + * @param[in] field The field of the element */ #undef EINA_CLIST_ENTRY #define EINA_CLIST_ENTRY(elem, type, field) \ diff --git a/src/lib/eina/eina_matrixsparse.h b/src/lib/eina/eina_matrixsparse.h index 6d1b98c9e9..301b7785e2 100644 --- a/src/lib/eina/eina_matrixsparse.h +++ b/src/lib/eina/eina_matrixsparse.h @@ -76,16 +76,16 @@ typedef struct _Eina_Matrixsparse_Cell Eina_Matrixsparse_Cell; /** * @brief Creates a new Sparse Matrix. * - * @param rows Number of rows in matrix. Operations with rows greater than this - * value will fail. - * @param cols Number of columns in matrix. Operations with columns greater - * than this value will fail. - * @param free_func Used to delete cell data contents, used by + * @param[in] rows Number of rows in matrix. Operations with rows + * greater than this value will fail. + * @param[in] cols Number of columns in matrix. Operations with columns + * greater than this value will fail. + * @param[in] free_func Used to delete cell data contents, used by * eina_matrixsparse_free(), eina_matrixsparse_size_set(), * eina_matrixsparse_row_idx_clear(), * eina_matrixsparse_column_idx_clear(), * eina_matrixsparse_cell_idx_clear() and possible others. - * @param user_data Given to @a free_func as first parameter. + * @param[in] user_data Given to @a free_func as first parameter. * * @return Newly allocated matrix, or @c NULL if allocation failed. */ @@ -98,7 +98,7 @@ EAPI Eina_Matrixsparse *eina_matrixsparse_new(unsigned long rows, /** * @brief Frees resources allocated for Sparse Matrix. * - * @param m The Sparse Matrix instance to free, must @b not be @c NULL. + * @param[in] m The Sparse Matrix instance to free, must @b not be @c NULL. */ EAPI void eina_matrixsparse_free(Eina_Matrixsparse *m); @@ -110,10 +110,11 @@ EAPI void eina_matrixsparse_free(Eina_Matrixsparse *m); * The given parameters are guaranteed to be set if they're not @c NULL, * even if this function fails (ie: @a m is not a valid matrix instance). * - * @param m The sparse matrix to operate on. - * @param rows Returns the number of rows, may be @c NULL. If @a m is invalid, - * returned value is zero, otherwise it's a positive integer. - * @param cols Returns the number of columns, may be @c NULL. If @a m is + * @param[in] m The sparse matrix to operate on. + * @param[out] rows Returns the number of rows, may be @c NULL. If @a m + * is invalid, returned value is zero, otherwise it's a positive + * integer. + * @param[out] cols Returns the number of columns, may be @c NULL. If @a m is * invalid, returned value is zero, otherwise it's a positive integer. */ EAPI void eina_matrixsparse_size_get(const Eina_Matrixsparse *m, @@ -126,9 +127,9 @@ EAPI void eina_matrixsparse_size_get(const Eina_Matrixsparse *m, * This will resize the sparse matrix, possibly freeing cells on rows * and columns that will cease to exist. * - * @param m The sparse matrix to operate on. - * @param rows The new number of rows, must be greater than zero. - * @param cols The new number of columns, must be greater than zero. + * @param[out] m The sparse matrix to operate on. + * @param[in] rows The new number of rows, must be greater than zero. + * @param[in] cols The new number of columns, must be greater than zero. * @return #EINA_TRUE on success, #EINA_FALSE on failure. * * @warning Cells, rows or columns are not reference counted and thus @@ -144,10 +145,10 @@ EAPI Eina_Bool eina_matrixsparse_size_set(Eina_Matrixsparse *m, /** * @brief Gets the cell reference inside Sparse Matrix. * - * @param m The sparse matrix to operate on. - * @param row The new number of row to clear. - * @param col The new number of column to clear. - * @param cell Pointer to return cell reference, if any exists. + * @param[in] m The sparse matrix to operate on. + * @param[in] row The new number of row to clear. + * @param[in] col The new number of column to clear. + * @param[out] cell Pointer to return cell reference, if any exists. * * @return @c 1 on success, @c 0 on failure. It is considered successful if did not * exist but index is inside matrix size, in this case @c *cell == NULL @@ -160,7 +161,7 @@ EAPI Eina_Bool eina_matrixsparse_cell_idx_get(const Eina_Matrixsparse *m, unsign /** * @brief Gets data associated with given cell reference. * - * @param cell Given cell reference, must @b not be @c NULL. + * @param[in] cell Given cell reference, must @b not be @c NULL. * * @return Data associated with given cell. * @@ -172,9 +173,9 @@ EAPI void *eina_matrixsparse_cell_data_get(const Eina_Matrixsparse_Cell *cel /** * @brief Gets data associated with given cell given its indexes. * - * @param m The sparse matrix to operate on. - * @param row The new number of row to clear. - * @param col The new number of column to clear. + * @param[in] m The sparse matrix to operate on. + * @param[in] row The new number of row to clear. + * @param[in] col The new number of column to clear. * * @return Data associated with given cell or @c NULL if nothing is associated. * @@ -186,9 +187,9 @@ EAPI void *eina_matrixsparse_data_idx_get(const Eina_Matrixsparse *m, unsign /** * @brief Gets position (indexes) of the given cell. * - * @param cell The cell reference, must @b not be @c NULL. - * @param row Where to store cell row number, may be @c NULL. - * @param col Where to store cell column number, may be @c NULL. + * @param[in] cell The cell reference, must @b not be @c NULL. + * @param[out] row Where to store cell row number, may be @c NULL. + * @param[out] col Where to store cell column number, may be @c NULL. * * @return #EINA_TRUE on success, #EINA_FALSE otherwise (@c cell is @c NULL). */ @@ -199,9 +200,9 @@ EAPI Eina_Bool eina_matrixsparse_cell_position_get(const Eina_Matrixsparse_Cell /** * @brief Changes cell reference value without freeing the possibly existing old value. * - * @param cell The cell reference, must @b not be @c NULL. - * @param data New data to set. - * @param p_old Returns the old value intact (not freed). + * @param[in,out] cell The cell reference, must @b not be @c NULL. + * @param[in] data New data to set. + * @param[out] p_old Returns the old value intact (not freed). * * @return #EINA_TRUE on success, #EINA_FALSE otherwise (@a cell is @c NULL). * @@ -216,8 +217,8 @@ EAPI Eina_Bool eina_matrixsparse_cell_data_replace(Eina_Matrixsparse_Cell *cell, * In contrast to eina_matrixsparse_cell_data_replace(), this function will * call @c free_func() on existing value. * - * @param cell The cell reference, must @b not be @c NULL. - * @param data New data to set. + * @param[in,out] cell The cell reference, must @b not be @c NULL. + * @param[in] data New data to set. * * @return #EINA_TRUE on success, #EINA_FALSE otherwise (@a cell is @c NULL). * @@ -230,11 +231,11 @@ EAPI Eina_Bool eina_matrixsparse_cell_data_set(Eina_Matrixsparse_Cell *cell, con * @brief Changes cell value without freeing the possibly existing old value, using * indexes. * - * @param m The sparse matrix, must @b not be @c NULL. - * @param row The row number to set the value. - * @param col The column number to set the value. - * @param data New data to set. - * @param p_old returns the old value intact (not freed). + * @param[in,out] m The sparse matrix, must @b not be @c NULL. + * @param[in] row The row number to set the value. + * @param[in] col The column number to set the value. + * @param[in] data New data to set. + * @param[out] p_old returns the old value intact (not freed). * * @return #EINA_TRUE on success, #EINA_FALSE otherwise (@a m is @c NULL, indexes are not valid). * @@ -250,10 +251,10 @@ EAPI Eina_Bool eina_matrixsparse_data_idx_replace(Eina_Matrixsparse *m, unsigned * In contrast to eina_matrixsparse_data_idx_replace(), this function will * call @c free_func() on existing value. * - * @param m The sparse matrix, must @b not be @c NULL. - * @param row The row number to set the value. - * @param col The column number to set the value. - * @param data New data to set. + * @param[in,out] m The sparse matrix, must @b not be @c NULL. + * @param[in] row The row number to set the value. + * @param[in] col The column number to set the value. + * @param[in] data New data to set. * * @return #EINA_TRUE on success, #EINA_FALSE otherwise (@a m is @c NULL, indexes are not valid). * @@ -269,8 +270,8 @@ EAPI Eina_Bool eina_matrixsparse_data_idx_set(Eina_Matrixsparse *m, unsigned lon * Existing cells will be cleared with @c free_func() given to * eina_matrixsparse_new(). * - * @param m The sparse matrix to operate on. - * @param row The new number of row to clear. + * @param[in,out] m The sparse matrix to operate on. + * @param[in] row The new number of row to clear. * * @return #EINA_TRUE on success, #EINA_FALSE on failure. It is considered successful if row * had no cells filled. Failure is asking for clear row outside @@ -288,8 +289,8 @@ EAPI Eina_Bool eina_matrixsparse_row_idx_clear(Eina_Matrixsparse *m, unsigned lo * Existing cells will be cleared with @c free_func() given to * eina_matrixsparse_new(). * - * @param m The sparse matrix to operate on. - * @param col The new number of column to clear. + * @param[in,out] m The sparse matrix to operate on. + * @param[in] col The new number of column to clear. * * @return #EINA_TRUE on success, #EINA_FALSE on failure. It is considered successful if column * had no cells filled. Failure is asking for clear column outside @@ -307,9 +308,9 @@ EAPI Eina_Bool eina_matrixsparse_column_idx_clear(Eina_Matrixsparse *m, unsigned * Existing cell will be cleared with @c free_func() given to * eina_matrixsparse_new(). * - * @param m The sparse matrix to operate on. - * @param row The new number of row to clear. - * @param col The new number of column to clear. + * @param[in,out] m The sparse matrix to operate on. + * @param[in] row The new number of row to clear. + * @param[in] col The new number of column to clear. * * @return #EINA_TRUE on success, #EINA_FALSE on failure. It is considered successful if did not * exist but index is inside matrix size. @@ -326,7 +327,7 @@ EAPI Eina_Bool eina_matrixsparse_cell_idx_clear(Eina_Matrixsparse *m, unsigned l /** * @brief Clears (erases) cell given its reference. * - * @param cell The cell reference, must @b not be @c NULL. + * @param[in,out] cell The cell reference, must @b not be @c NULL. * * @return #EINA_TRUE on success, #EINA_FALSE on failure. * @@ -352,7 +353,7 @@ EAPI Eina_Bool eina_matrixsparse_cell_clear(Eina_Matrixsparse_Cell *cell); * position with eina_matrixsparse_cell_position_get() and cell value * with eina_matrixsparse_cell_data_get(). * - * @param m The Sparse Matrix reference, must @b not be @c NULL. + * @param[in] m The Sparse Matrix reference, must @b not be @c NULL. * @return A new iterator. * * @warning If the matrix structure changes then the iterator becomes @@ -378,7 +379,7 @@ EAPI Eina_Iterator *eina_matrixsparse_iterator_new(const Eina_Matrixsparse *m); * reference will be a dummy/placeholder, thus setting value with * eina_matrixsparse_cell_data_set() will leave pointer unreferenced. * - * @param m The Sparse Matrix reference, must @b not be @c NULL. + * @param[in] m The Sparse Matrix reference, must @b not be @c NULL. * @return A new iterator. * * @warning If the matrix structure changes then the iterator becomes --
