forked from enlightenment/efl
doxygen docs: Fix several warnings in Eina files
This commit is contained in:
parent
8e20d28dfe
commit
50f83d5d3a
|
@ -388,7 +388,7 @@ EAPI Eina_Accessor* eina_carray_length_ptr_accessor_new(void** array, unsigned i
|
|||
* @def EINA_C_ARRAY_ACCESSOR_NEW
|
||||
* @brief Creates an Eina_Accessor that wraps a plain fixed size C array
|
||||
*
|
||||
* @param[in] array The array
|
||||
* @param[in] Array The array
|
||||
* @return The accessor that will give access to the passed array
|
||||
*
|
||||
* You can create it like this:
|
||||
|
@ -403,7 +403,7 @@ EAPI Eina_Accessor* eina_carray_length_ptr_accessor_new(void** array, unsigned i
|
|||
* @def EINA_C_ARRAY_ACCESSOR_NEW
|
||||
* @brief Creates an Eina_Accessor that wraps a plain fixed size C array
|
||||
*
|
||||
* @param[in] array The array
|
||||
* @param[in] Array The array
|
||||
* @return The accessor that will give access to the passed array
|
||||
*
|
||||
* You can create it like this:
|
||||
|
|
|
@ -108,7 +108,7 @@ typedef Eina_Bool (*Eina_Debug_Timer_Cb)(void *);
|
|||
typedef struct _Eina_Debug_Timer Eina_Debug_Timer;
|
||||
|
||||
/**
|
||||
* @typedef Eina_Debug_Packet_Header
|
||||
* @struct Eina_Debug_Packet_Header
|
||||
*
|
||||
* Header of Eina Debug packet
|
||||
*/
|
||||
|
@ -143,7 +143,7 @@ typedef struct
|
|||
}
|
||||
|
||||
/**
|
||||
* @typedef Eina_Debug_Opcode
|
||||
* @struct Eina_Debug_Opcode
|
||||
*
|
||||
* Structure to describe information for an opcode. It is used to register new
|
||||
* opcodes.
|
||||
|
|
|
@ -107,7 +107,7 @@ typedef Eina_Bool Eina_Success_Flag;
|
|||
#define EINA_ERROR_NO_ERROR ((Eina_Error)0)
|
||||
|
||||
/**
|
||||
* @var EINA_ERROR_OUT_OF_MEMORY
|
||||
* @var Eina_Error EINA_ERROR_OUT_OF_MEMORY
|
||||
* @brief The error identifier corresponding to lack of memory.
|
||||
*
|
||||
* @deprecated since 1.19, same as @c ENOMEM from @c errno.h
|
||||
|
|
|
@ -320,7 +320,7 @@ typedef unsigned int (*Eina_Key_Length)(const void *key);
|
|||
typedef int (*Eina_Key_Cmp)(const void *key1, int key1_length, const void *key2, int key2_length);
|
||||
/**
|
||||
* @def EINA_KEY_CMP
|
||||
* @param[in]Function The function used to compare hash key.
|
||||
* @param[in] Function The function used to compare hash key.
|
||||
*/
|
||||
#define EINA_KEY_CMP(Function) ((Eina_Key_Cmp)Function)
|
||||
|
||||
|
|
|
@ -322,7 +322,7 @@ EAPI Eina_Iterator *eina_carray_length_iterator_new(void** array, unsigned int s
|
|||
* @brief Creates an Eina_Iterator that iterates through a
|
||||
* NUL-terminated C array.
|
||||
*
|
||||
* @param[in] array The NUL-terminated array
|
||||
* @param[in] Array The NUL-terminated array
|
||||
* @return The iterator that will walk over the array.
|
||||
*
|
||||
* You can create it like this:
|
||||
|
@ -370,10 +370,10 @@ EAPI Eina_Iterator *eina_multi_iterator_internal_new(Eina_Iterator *it, ...) EIN
|
|||
* @brief Calls the process method on each node of iterator, producing new "processed"
|
||||
* nodes and returning a new iterator which contains them.
|
||||
*
|
||||
* @param[in] original Iterator containing the nodes to process.
|
||||
* @param[in] iterator Iterator containing the nodes to process.
|
||||
* @param[in] process Method to call on each node.
|
||||
* @param[in] free_cb Method called when all nodes have been processed. It receives "data" as a parameter.
|
||||
* @param[in] data Additional data passed to the process method.
|
||||
* @param[in] fdata Additional data passed to the process method.
|
||||
*
|
||||
* Processes every node in the input iterator and returns a new iterator containing
|
||||
* the processed nodes. This is akin to a Map function:
|
||||
|
@ -388,7 +388,7 @@ EAPI Eina_Iterator* eina_iterator_processed_new(Eina_Iterator *iterator, Eina_Pr
|
|||
* @brief Creates an Eina_Iterator that iterates through a series
|
||||
* of Eina_Iterator.
|
||||
*
|
||||
* @param[in] it The first Eina_Iterator to iterate over
|
||||
* @param[in] It The first Eina_Iterator to iterate over
|
||||
* @return The iterator that will walk all the other iterator
|
||||
*
|
||||
* Eina_Iterator* iterator = eina_multi_iterator_new(it1, it2, it3);
|
||||
|
|
|
@ -1371,7 +1371,7 @@ EAPI int eina_list_data_idx(const Eina_List *list, void *data)
|
|||
*
|
||||
* @param[in] list The list to iterate over.
|
||||
* @param[out] l A list that is used as an iterator and points to the current node.
|
||||
* @param[out] data Current item's data.
|
||||
* @param[out] _data Current item's data.
|
||||
*
|
||||
* This macro iterates over @p list from the first element to
|
||||
* the last. @p data is the data related to the current element.
|
||||
|
@ -1429,7 +1429,7 @@ EAPI int eina_list_data_idx(const Eina_List *list, void *data)
|
|||
*
|
||||
* @param[in] list The list to iterate over.
|
||||
* @param[out] l A list that is used as an iterator and points to the current node.
|
||||
* @param[out] data Current item's data.
|
||||
* @param[out] _data Current item's data.
|
||||
*
|
||||
* This macro works like EINA_LIST_FOREACH, but iterates from the
|
||||
* last element of a list to the first.
|
||||
|
|
|
@ -261,7 +261,7 @@ static inline Eina_Bool eina_condition_wait(Eina_Condition *cond);
|
|||
* @param[in] t The maximum amount of time to wait, in seconds.
|
||||
*
|
||||
* @return #EINA_TRUE on success, #EINA_FALSE otherwise. If the operation
|
||||
* timed out, eina error will be set to #ETIMEDOUT.
|
||||
* timed out, eina error will be set to @c ETIMEDOUT.
|
||||
*
|
||||
* @see eina_condition_wait()
|
||||
*/
|
||||
|
@ -545,7 +545,7 @@ static inline Eina_Bool eina_barrier_wait(Eina_Barrier *barrier);
|
|||
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
|
||||
*
|
||||
* @note Spinlocks are only implemented on the POSIX platform and are only available
|
||||
* if #EINA_HAVE_POSIX_SPINLOCK is defined. you get a new #Eina_Lock on All other platforms.
|
||||
* if @c EINA_HAVE_POSIX_SPINLOCK is defined. You get a new #Eina_Lock on All other platforms.
|
||||
*
|
||||
* @see eina_spinlock_free()
|
||||
*/
|
||||
|
|
|
@ -392,7 +392,7 @@ EAPI void eina_matrix3_compose(const Eina_Matrix3 *m1,
|
|||
*
|
||||
* @since 1.14
|
||||
*/
|
||||
EAPI void eina_matrix3_translate(Eina_Matrix3 *t, double tx, double ty);
|
||||
EAPI void eina_matrix3_translate(Eina_Matrix3 *m, double tx, double ty);
|
||||
|
||||
/**
|
||||
* @brief Sets the matrix values for a scaling operation.
|
||||
|
@ -403,16 +403,16 @@ EAPI void eina_matrix3_translate(Eina_Matrix3 *t, double tx, double ty);
|
|||
*
|
||||
* @since 1.14
|
||||
*/
|
||||
EAPI void eina_matrix3_scale(Eina_Matrix3 *t, double sx, double sy);
|
||||
EAPI void eina_matrix3_scale(Eina_Matrix3 *m, double sx, double sy);
|
||||
|
||||
/**
|
||||
* @brief Sets the matrix values for a rotation operation.
|
||||
* @param[out] t The matrix.
|
||||
* @param[out] m The matrix.
|
||||
* @param[in] rad The number of radians to rotate.
|
||||
*
|
||||
* @since 1.14
|
||||
*/
|
||||
EAPI void eina_matrix3_rotate(Eina_Matrix3 *t, double rad);
|
||||
EAPI void eina_matrix3_rotate(Eina_Matrix3 *m, double rad);
|
||||
|
||||
/**
|
||||
* @brief Sets the given floating point matrix to the identity matrix.
|
||||
|
@ -424,7 +424,7 @@ EAPI void eina_matrix3_rotate(Eina_Matrix3 *t, double rad);
|
|||
*
|
||||
* @since 1.14
|
||||
*/
|
||||
EAPI void eina_matrix3_identity(Eina_Matrix3 *t);
|
||||
EAPI void eina_matrix3_identity(Eina_Matrix3 *m);
|
||||
|
||||
/**
|
||||
* @brief Calculates the determinant of the given matrix.
|
||||
|
|
|
@ -550,7 +550,7 @@ EAPI Eina_Rectangle *eina_rectangle_new(int x, int y, int w, int h) EINA_MALLOC
|
|||
/**
|
||||
* @brief Frees the given rectangle.
|
||||
*
|
||||
* @param[iin] rect The rectangle to free.
|
||||
* @param[in] rect The rectangle to free.
|
||||
*
|
||||
* This function removes @p rect from the rectangles pool.
|
||||
*/
|
||||
|
|
|
@ -362,7 +362,7 @@ static inline char *eina_slice_strdup(const Eina_Slice slice);
|
|||
/**
|
||||
* @brief A null-terminated string for this slice.
|
||||
*
|
||||
* @param[in] slice the reference memory.
|
||||
* @param[in] rw_slice the reference memory.
|
||||
* @return newly allocated memory or @c NULL on error
|
||||
*
|
||||
* @since 1.19
|
||||
|
|
|
@ -1847,10 +1847,10 @@ static inline Eina_Bool eina_value_array_value_get(const Eina_Value *src,
|
|||
* @brief Definition for the macro to iterate over an array contained in an Eina_Value.
|
||||
* @since 1.21
|
||||
*
|
||||
* @param[in] array The list to iterate over.
|
||||
* @param[in] length Contain the length of the array
|
||||
* @param[out] it Contain the current position walked over
|
||||
* @param[out] value Contain the value at the current position.
|
||||
* @param[in] Array The list to iterate over.
|
||||
* @param[in] Length Contain the length of the array
|
||||
* @param[out] It Contain the current position walked over
|
||||
* @param[out] Value Contain the value at the current position.
|
||||
*
|
||||
* This macro iterates over @p array from the first element to
|
||||
* the last. @p value is the data related to the current element.
|
||||
|
@ -1966,7 +1966,7 @@ static inline Eina_Bool eina_value_list_setup(Eina_Value *value,
|
|||
/**
|
||||
* @brief Queries number of elements in value of list type.
|
||||
*
|
||||
* @param[in]value value object.
|
||||
* @param[in] value value object.
|
||||
* @return number of child elements.
|
||||
*
|
||||
* @since 1.2
|
||||
|
|
Loading…
Reference in New Issue