diff --git a/src/lib/eina/eina_evlog.h b/src/lib/eina/eina_evlog.h index ecd8fa0e05..532fe81047 100644 --- a/src/lib/eina/eina_evlog.h +++ b/src/lib/eina/eina_evlog.h @@ -106,10 +106,10 @@ struct _Eina_Evlog_Buf * state at the time of the log events or a series of parameters and input * that caused this event. * - * @param event The event string - see above for format - * @param obj An optional object "pointer" to associate - * @param srctime An optional source event timestamp that caused this event - * @param detail An optional event detail string with more info + * @param[in] event The event string - see above for format + * @param[in] obj An optional object "pointer" to associate + * @param[in] srctime An optional source event timestamp that caused this event + * @param[in] detail An optional event detail string with more info * * @since 1.15 */ diff --git a/src/lib/eina/eina_file.h b/src/lib/eina/eina_file.h index 77770e26ef..ea3e79481d 100644 --- a/src/lib/eina/eina_file.h +++ b/src/lib/eina/eina_file.h @@ -105,9 +105,9 @@ typedef struct _Eina_File_Line Eina_File_Line; * @typedef Eina_File_Dir_List_Cb * @brief Type for a callback to be called when iterating over the files of a * directory. - * @param name The file name EXCLUDING the path - * @param path The path passed to eina_file_dir_list() - * @param data The data passed to eina_file_dir_list() + * @param[in] name The file name EXCLUDING the path + * @param[in] path The path passed to eina_file_dir_list() + * @param[in] data The data passed to eina_file_dir_list() */ typedef void (*Eina_File_Dir_List_Cb)(const char *name, const char *path, void *data); @@ -240,7 +240,7 @@ struct _Eina_File_Line * @def EINA_FILE_DIR_LIST_CB * @brief The macro to cast to an #Eina_File_Dir_List_Cb. * @details This macro casts @p function to #Eina_File_Dir_List_Cb. - * @param function The function to cast + * @param[in] function The function to cast * */ #define EINA_FILE_DIR_LIST_CB(function) ((Eina_File_Dir_List_Cb)function) @@ -514,7 +514,7 @@ eina_file_virtualize(const char *virtual_name, const void *data, unsigned long l /** * @brief Tells if a file is a real file or only exists in memory. * - * @param file The file to test + * @param[in] file The file to test * @return #EINA_TRUE if the file is a virtual file * * @since 1.8 @@ -527,7 +527,7 @@ eina_file_virtual(Eina_File *file) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); * @details All current map continue to exist. You need to manually delete * and recreate them to have the new correct mapping. * - * @param file The file to refresh + * @param[in,out] file The file to refresh * @return #EINA_TRUE if the file has changed * * @since 1.8 @@ -537,7 +537,7 @@ EAPI Eina_Bool eina_file_refresh(Eina_File *file); /** * @brief Duplicates a read-only handler of a previously open file. * - * @param file To duplicate a reference to + * @param[in] file To duplicate a reference to * @return #Eina_File handle of the duplicated file * * @note Opens a file in read-only mode. @@ -699,12 +699,12 @@ EAPI Eina_Bool eina_file_map_faulted(Eina_File *file, void *map); * @details This function is similar to eina_str_join_len(), but the separator * is '\' on Windows and '/' otherwise. * - * @param dst The buffer to store the result. - * @param size Size (in byte) of the buffer. - * @param a First path to use. - * @param a_len length of @p a. - * @param b Second path to use. - * @param b_len length of @p b. + * @param[out] dst The buffer to store the result. + * @param[in] size Size (in byte) of the buffer. + * @param[in] a First path to use. + * @param[in] a_len length of @p a. + * @param[in] b Second path to use. + * @param[in] b_len length of @p b. * @return The number of characters printed. * * @see eina_str_join_len() @@ -725,10 +725,10 @@ static inline size_t eina_file_path_join_len(char *dst, * the length of @p a and @p b using strlen(). The path separator is * '\' on Windows and '/' otherwise. * - * @param dst The buffer to store the result. - * @param size Size (in byte) of the buffer. - * @param a First string to use. - * @param b Second string to use. + * @param[out] dst The buffer to store the result. + * @param[in] size Size (in byte) of the buffer. + * @param[in] a First string to use. + * @param[in] b Second string to use. * @return The number of characters printed. * * @see eina_file_path_join_len() @@ -746,7 +746,7 @@ static inline size_t eina_file_path_join(char *dst, * @details This function is a wrapper around the unlink() system call. It removes a link to * a file. * - * @param pathname File name to unlink. + * @param[in] pathname File name to unlink. * @return #EINA_TRUE if the unlink was successful, #EINA_FALSE otherwise.. * * @since 1.19 @@ -758,8 +758,8 @@ EAPI Eina_Bool eina_file_unlink(const char *pathname); * @details This function is a wrapper around the fnctl() system call. It makes sure * that the fd will be closed whenever exec is called. * - * @param fd File descriptor to enforce close on exec on. - * @param on #EINA_TRUE will turn close on exec on, #EINA_FALSE will turn it off. + * @param[in] fd File descriptor to enforce close on exec on. + * @param[in] on #EINA_TRUE will turn close on exec on, #EINA_FALSE will turn it off. * @return #EINA_TRUE if it will be closed on exec, #EINA_FALSE otherwise.. * * @since 1.20 diff --git a/src/lib/eina/eina_file_common.h b/src/lib/eina/eina_file_common.h index 2fc87001e5..c7ee3f87eb 100644 --- a/src/lib/eina/eina_file_common.h +++ b/src/lib/eina/eina_file_common.h @@ -179,8 +179,8 @@ struct _Eina_Lines_Iterator * The implementation simply checks if the first char in the path is '/'. If it * is not, the path is considered relative. * - * @param path The path to check. - + * @param[in] path The path to check. + * * @return EINA_TRUE if the path is relative, EINA_FALSE otherwise. * */ @@ -192,8 +192,8 @@ Eina_Bool eina_file_path_relative(const char *path); * be appended to the current working directory. Presumably, this will be a * relative path. * - * @param path The path to append to the current directory. - * @param len The length of @p path. + * @param[in] path The path to append to the current directory. + * @param[in] len The length of @p path. * * @return A pointer to a string that contains the absolute path to the current * working directory plus any path you send in. @@ -204,7 +204,7 @@ Eina_Tmpstr *eina_file_current_directory_get(const char *path, size_t len); /** * @brief Cleans up Eina after a file is no longer needed. * - * @param path The path of the file. + * @param[in,out] path The path of the file. * * @return On success, it will return the @p path string. If @p path is @c NULL, * it will return and empty string. @@ -215,7 +215,7 @@ char *eina_file_cleanup(Eina_Tmpstr *path); /** * @brief Closes and cleans up after an Eina file. * - * @param file The path of the file. + * @param[in,out] file The path of the file. * */ void eina_file_clean_close(Eina_File *file); @@ -223,7 +223,7 @@ void eina_file_clean_close(Eina_File *file); /** * @brief Closes a file from the OS perspective. * - * @param file The path of the file. + * @param[in,out] file The path of the file. * */ void eina_file_real_close(Eina_File *file); @@ -234,8 +234,8 @@ void eina_file_real_close(Eina_File *file); * the memory maps for the file. If the file has shrunk, it also adds any mapped * regions past the end of the file to the dead_map. * - * @param file The file. - * @param length The current length of the file after the change. + * @param[in,out] file The file. + * @param[in] length The current length of the file after the change. * */ void eina_file_flush(Eina_File *file, unsigned long int length); @@ -247,10 +247,10 @@ void eina_file_flush(Eina_File *file, unsigned long int length); * the map is part of the dead_map, @p free_func will be called to handle the actual * deallocation. * - * @param file The file. - * @param map The memory mapped region that is to be freed. - * @param free_func A pointer to a function that will be called to free up the - * resources used by the map. + * @param[in,out] file The file. + * @param[in,out] map The memory mapped region that is to be freed. + * @param[in] free_func A pointer to a function that will be called to + * free up the resources used by the map. * */ void eina_file_common_map_free(Eina_File *file, void *map, @@ -277,9 +277,9 @@ void *eina_file_virtual_map_all(Eina_File *file); /** * @brief Map a part of a virtual file to a buffer. * - * @param file The virtual file to map in memory - * @param offset The offset inside the file to start mapping - * @param length The length of the region to map + * @param[in,out] file The virtual file to map in memory + * @param[in] offset The offset inside the file to start mapping + * @param[in] length The length of the region to map * */ void *eina_file_virtual_map_new(Eina_File *file, @@ -288,8 +288,8 @@ void *eina_file_virtual_map_new(Eina_File *file, /** * @brief Unref and unmap memory if possible. * - * @param file The file handler to unmap memory from. - * @param map Memory map to unref and unmap. + * @param[in,out] file The file handler to unmap memory from. + * @param[in,out] map Memory map to unref and unmap. * */ void eina_file_virtual_map_free(Eina_File *file, void *map); @@ -300,7 +300,7 @@ void eina_file_virtual_map_free(Eina_File *file, void *map); * @warning This function is not yet implemented. At present it only returns * @code sizeof (unsigned long int) * 2 @endcode * - * @param key The key for which length will be calculated. + * @param[in] key The key for which length will be calculated. * * @return The length of the key. * @@ -312,10 +312,10 @@ unsigned int eina_file_map_key_length(const void *key); * The implementation assumes that @p key1 and @p key2 are both pointers to an * array with 2 elements, as is the case with the Eina file map keys. * - * @param key1 The first key. - * @param key1_length The length of the first key. - * @param key2 The second key. - * @param key2_length The length of the second key. + * @param[in] key1 The first key. + * @param[in] key1_length The length of the first key. + * @param[in] key2 The second key. + * @param[in] key2_length The length of the second key. * * @return Positive number if Key1 > Key2, else a negative number. Will return * zero if both elements of the key are exactly the same. @@ -327,8 +327,8 @@ int eina_file_map_key_cmp(const unsigned long long int *key1, int key1_length, /** * @brief Creates a hash from a map key. * - * @param key A pointer to the key. - * @param key_length The length of the key. + * @param[in] key A pointer to the key. + * @param[in] key_length The length of the key. * * @return A key hash. * diff --git a/src/lib/eina/eina_fp.h b/src/lib/eina/eina_fp.h index b176aca62e..b8ffb84f71 100644 --- a/src/lib/eina/eina_fp.h +++ b/src/lib/eina/eina_fp.h @@ -79,7 +79,7 @@ typedef int32_t Eina_F8p24; * @brief Creates a new Eina_F32p32 floating point number from standard 32-bit * integer * - * @param v 32-bit integer value to convert + * @param[in] v 32-bit integer value to convert * @return The value converted into Eina_F32p32 format */ static inline Eina_F32p32 eina_f32p32_int_from(int32_t v); @@ -88,7 +88,7 @@ static inline Eina_F32p32 eina_f32p32_int_from(int32_t v); * @brief Creates a new standard 32-bit integer from Eina_F32p32 floating point * number * - * @param v Eina_F32p32 value to convert + * @param[in] v Eina_F32p32 value to convert * @return The value converted into 32-bit integer */ static inline int32_t eina_f32p32_int_to(Eina_F32p32 v); @@ -96,7 +96,7 @@ static inline int32_t eina_f32p32_int_to(Eina_F32p32 v); /** * @brief Creates a new Eina_F32p32 floating point number from standard double * - * @param v Double value to convert + * @param[in] v Double value to convert * @return The value converted into Eina_F32p32 format */ static inline Eina_F32p32 eina_f32p32_double_from(double v); @@ -105,7 +105,7 @@ static inline Eina_F32p32 eina_f32p32_double_from(double v); * @brief Creates a new standard double from Eina_F32p32 floating point * number * - * @param v Eina_F32p32 value to convert + * @param[in] v Eina_F32p32 value to convert * @return The value converted into double */ static inline double eina_f32p32_double_to(Eina_F32p32 v); @@ -113,8 +113,8 @@ static inline double eina_f32p32_double_to(Eina_F32p32 v); /** * @brief Calculates the sum of two Eina_F32p32 floating point numbers * - * @param a The first number - * @param b The second number + * @param[in] a The first number + * @param[in] b The second number * @return The sum result of the two numbers @p a + @p b */ static inline Eina_F32p32 eina_f32p32_add(Eina_F32p32 a, Eina_F32p32 b); @@ -122,8 +122,8 @@ static inline Eina_F32p32 eina_f32p32_add(Eina_F32p32 a, Eina_F32p32 b); /** * @brief Calculates the subtraction of two Eina_F32p32 floating point numbers * - * @param a The first number - * @param b The subtracted number + * @param[in] a The first number + * @param[in] b The subtracted number * @return The subtraction result of the two numbers @p a - @p b */ static inline Eina_F32p32 eina_f32p32_sub(Eina_F32p32 a, Eina_F32p32 b); @@ -131,8 +131,8 @@ static inline Eina_F32p32 eina_f32p32_sub(Eina_F32p32 a, Eina_F32p32 b); /** * @brief Calculates the multiplication of two Eina_F32p32 floating point numbers * - * @param a The first number - * @param b The second number + * @param[in] a The first number + * @param[in] b The second number * @return The multiplication result of the two numbers @p a * @p b * * To prevent overflow during multiplication we need to reduce the precision of @@ -146,8 +146,8 @@ static inline Eina_F32p32 eina_f32p32_mul(Eina_F32p32 a, Eina_F32p32 b); * @brief Calculates the scale multiplication of one Eina_F32p32 floating point * number with an integer * - * @param a The Eina_F32p32 number - * @param b The integer value + * @param[in] a The Eina_F32p32 number + * @param[in] b The integer value * @return The multiplication result of the two numbers @p a * @p b */ static inline Eina_F32p32 eina_f32p32_scale(Eina_F32p32 a, int b); @@ -155,8 +155,8 @@ static inline Eina_F32p32 eina_f32p32_scale(Eina_F32p32 a, int b); /** * @brief Calculates the division of two Eina_F32p32 floating point numbers * - * @param a The numerator number - * @param b The denominator number + * @param[in] a The numerator number + * @param[in] b The denominator number * @return The division result of the two numbers @p a / @p b */ static inline Eina_F32p32 eina_f32p32_div(Eina_F32p32 a, Eina_F32p32 b); @@ -164,7 +164,7 @@ static inline Eina_F32p32 eina_f32p32_div(Eina_F32p32 a, Eina_F32p32 b); /** * @brief Calculates the square root of an Eina_F32p32 floating point number * - * @param a The number to calculate the square root from + * @param[in] a The number to calculate the square root from * @return The square root result for the number @p a */ static inline Eina_F32p32 eina_f32p32_sqrt(Eina_F32p32 a); @@ -173,7 +173,7 @@ static inline Eina_F32p32 eina_f32p32_sqrt(Eina_F32p32 a); * @brief Gets the absolute value of the integer part of and Eina_F32p32 floating * point number * - * @param v The floating point number + * @param[in] v The floating point number * @return The positive integer part of the number @p v */ static inline unsigned int eina_f32p32_fracc_get(Eina_F32p32 v); @@ -181,7 +181,7 @@ static inline unsigned int eina_f32p32_fracc_get(Eina_F32p32 v); /** * @brief Gets the absolute value of an Eina_F32p32 floating point number * - * @param a The floating point number + * @param[in] a The floating point number * @return The absolute value for the number @p a * @warning Has known issues on 64-bit architecture, prefer * eina_f32p32_fracc_get() instead @@ -191,7 +191,7 @@ static inline unsigned int eina_f32p32_fracc_get(Eina_F32p32 v); /** * @brief Calculates the cosinus of a floating point number * - * @param a The angle in radians to calculate the cosinus from. + * @param[in] a The angle in radians to calculate the cosinus from. * @return The cosinus value of the angle @p a */ EAPI Eina_F32p32 eina_f32p32_cos(Eina_F32p32 a); @@ -199,7 +199,7 @@ EAPI Eina_F32p32 eina_f32p32_cos(Eina_F32p32 a); /** * @brief Calculates the sinus of a floating point number * - * @param a The angle in radians to calculate the sinus from. + * @param[in] a The angle in radians to calculate the sinus from. * @return The cosinus value of the angle @p a */ EAPI Eina_F32p32 eina_f32p32_sin(Eina_F32p32 a); @@ -223,7 +223,7 @@ EAPI Eina_F32p32 eina_f32p32_sin(Eina_F32p32 a); * @brief Creates a new Eina_F16p316 floating point number from standard 32-bit * integer * - * @param v 32-bit integer value to convert + * @param[in] v 32-bit integer value to convert * @return The value converted into Eina_F16p16 format */ static inline Eina_F16p16 eina_f16p16_int_from(int32_t v); @@ -232,7 +232,7 @@ static inline Eina_F16p16 eina_f16p16_int_from(int32_t v); * @brief Creates a new standard 32-bit integer from Eina_F16p16 floating point * number * - * @param v Eina_F16p16 value to convert + * @param[in] v Eina_F16p16 value to convert * @return The value converted into 32-bit integer */ static inline int32_t eina_f16p16_int_to(Eina_F16p16 v); @@ -240,7 +240,7 @@ static inline int32_t eina_f16p16_int_to(Eina_F16p16 v); /** * @brief Creates a new Eina_F16p16 floating point number from standard double * - * @param v Double value to convert + * @param[in] v Double value to convert * @return The value converted into Eina_F16p16 format */ static inline Eina_F16p16 eina_f16p16_double_from(double v); @@ -249,7 +249,7 @@ static inline Eina_F16p16 eina_f16p16_double_from(double v); * @brief Creates a new standard double from Eina_F16p16 floating point * number * - * @param v Eina_F16p16 value to convert + * @param[in] v Eina_F16p16 value to convert * @return The value converted into double */ static inline double eina_f16p16_double_to(Eina_F16p16 v); @@ -257,7 +257,7 @@ static inline double eina_f16p16_double_to(Eina_F16p16 v); /** * @brief Creates a new Eina_F16p16 floating point number from standard float * - * @param v Float value to convert + * @param[in] v Float value to convert * @return The value converted into Eina_F16p16 format */ static inline Eina_F16p16 eina_f16p16_float_from(float v); @@ -266,7 +266,7 @@ static inline Eina_F16p16 eina_f16p16_float_from(float v); * @brief Creates a new standard float from Eina_F16p16 floating point * number * - * @param v Eina_F16p16 value to convert + * @param[in] v Eina_F16p16 value to convert * @return The value converted into float */ static inline float eina_f16p16_float_to(Eina_F16p16 v); @@ -274,8 +274,8 @@ static inline float eina_f16p16_float_to(Eina_F16p16 v); /** * @brief Calculates the sum of two Eina_F16p16 floating point numbers * - * @param a The first number - * @param b The second number + * @param[in] a The first number + * @param[in] b The second number * @return The sum result of the two numbers @p a + @p b */ static inline Eina_F16p16 eina_f16p16_add(Eina_F16p16 a, Eina_F16p16 b); @@ -283,8 +283,8 @@ static inline Eina_F16p16 eina_f16p16_add(Eina_F16p16 a, Eina_F16p16 b); /** * @brief Calculates the subtraction of two Eina_F16p16 floating point numbers * - * @param a The first number - * @param b The subtracted number + * @param[in] a The first number + * @param[in] b The subtracted number * @return The subtraction result of the two numbers @p a - @p b */ static inline Eina_F16p16 eina_f16p16_sub(Eina_F16p16 a, Eina_F16p16 b); @@ -292,8 +292,8 @@ static inline Eina_F16p16 eina_f16p16_sub(Eina_F16p16 a, Eina_F16p16 b); /** * @brief Calculates the multiplication of two Eina_F16p16 floating point numbers * - * @param a The first number - * @param b The second number + * @param[in] a The first number + * @param[in] b The second number * @return The multiplication result of the two numbers @p a * @p b */ static inline Eina_F16p16 eina_f16p16_mul(Eina_F16p16 a, Eina_F16p16 b); @@ -302,8 +302,8 @@ static inline Eina_F16p16 eina_f16p16_mul(Eina_F16p16 a, Eina_F16p16 b); * @brief Calculates the scale multiplication of one Eina_F16p16 floating point * number with an integer * - * @param a The Eina_F16p16 number - * @param b The integer value + * @param[in] a The Eina_F16p16 number + * @param[in] b The integer value * @return The multiplication result of the two numbers @p a * @p b */ static inline Eina_F16p16 eina_f16p16_scale(Eina_F16p16 a, int b); @@ -311,8 +311,8 @@ static inline Eina_F16p16 eina_f16p16_scale(Eina_F16p16 a, int b); /** * @brief Calculates the division of two Eina_F16p16 floating point numbers * - * @param a The numerator number - * @param b The denominator number + * @param[in] a The numerator number + * @param[in] b The denominator number * @return The division result of the two numbers @p a / @p b */ static inline Eina_F16p16 eina_f16p16_div(Eina_F16p16 a, Eina_F16p16 b); @@ -320,7 +320,7 @@ static inline Eina_F16p16 eina_f16p16_div(Eina_F16p16 a, Eina_F16p16 b); /** * @brief Calculates the square root of an Eina_F16p16 floating point number * - * @param a The number to calculate the square root from + * @param[in] a The number to calculate the square root from * @return The square root result for the number @p a */ static inline Eina_F16p16 eina_f16p16_sqrt(Eina_F16p16 a); @@ -329,7 +329,7 @@ static inline Eina_F16p16 eina_f16p16_sqrt(Eina_F16p16 a); * @brief Gets the absolute value of the integer part of and Eina_F16p16 floating * point number * - * @param v The floating point number + * @param[in] v The floating point number * @return The positive integer part of the number @p v */ static inline unsigned int eina_f16p16_fracc_get(Eina_F16p16 v); @@ -339,7 +339,7 @@ static inline unsigned int eina_f16p16_fracc_get(Eina_F16p16 v); * @brief Creates a new Eina_F16p316 floating point number from standard 32-bit * integer * - * @param v 32-bit integer value to convert + * @param[in] v 32-bit integer value to convert * @return The value converted into Eina_F8p24 format */ static inline Eina_F8p24 eina_f8p24_int_from(int32_t v); @@ -348,7 +348,7 @@ static inline Eina_F8p24 eina_f8p24_int_from(int32_t v); * @brief Creates a new standard 32-bit integer from Eina_F8p24 floating point * number * - * @param v Eina_F8p24 value to convert + * @param[in] v Eina_F8p24 value to convert * @return The value converted into 32-bit integer */ static inline int32_t eina_f8p24_int_to(Eina_F8p24 v); @@ -356,7 +356,7 @@ static inline int32_t eina_f8p24_int_to(Eina_F8p24 v); /** * @brief Creates a new Eina_F8p24 floating point number from standard float * - * @param v Float value to convert + * @param[in] v Float value to convert * @return The value converted into Eina_F8p24 format */ static inline Eina_F8p24 eina_f8p24_float_from(float v); @@ -364,7 +364,7 @@ static inline Eina_F8p24 eina_f8p24_float_from(float v); /** * @brief Create a new standard float from Eina_F8p24 floating point number * - * @param v Eina_F8p24 value to convert + * @param[in] v Eina_F8p24 value to convert * @return The value converted into float */ static inline float eina_f8p24_float_to(Eina_F8p24 v); @@ -372,8 +372,8 @@ static inline float eina_f8p24_float_to(Eina_F8p24 v); /** * @brief Calculates the sum of two Eina_F8p24 floating point numbers * - * @param a The first number - * @param b The second number + * @param[in] a The first number + * @param[in] b The second number * @return The sum result of the two numbers @p a + @p b */ static inline Eina_F8p24 eina_f8p24_add(Eina_F8p24 a, Eina_F8p24 b); @@ -381,8 +381,8 @@ static inline Eina_F8p24 eina_f8p24_add(Eina_F8p24 a, Eina_F8p24 b); /** * @brief Calculates the subtraction of two Eina_F8p24 floating point numbers * - * @param a The first number - * @param b The subtracted number + * @param[in] a The first number + * @param[in] b The subtracted number * @return The subtraction result of the two numbers @p a - @p b */ static inline Eina_F8p24 eina_f8p24_sub(Eina_F8p24 a, Eina_F8p24 b); @@ -390,8 +390,8 @@ static inline Eina_F8p24 eina_f8p24_sub(Eina_F8p24 a, Eina_F8p24 b); /** * @brief Calculates the multiplication of two Eina_F8p24 floating point numbers * - * @param a The first number - * @param b The second number + * @param[in] a The first number + * @param[in] b The second number * @return The multiplication result of the two numbers @p a * @p b */ static inline Eina_F8p24 eina_f8p24_mul(Eina_F8p24 a, Eina_F8p24 b); @@ -400,8 +400,8 @@ static inline Eina_F8p24 eina_f8p24_mul(Eina_F8p24 a, Eina_F8p24 b); * @brief Calculates the scale multiplication of one Eina_F8p24 floating point * number with an integer * - * @param a The Eina_F16p16 number - * @param b The integer value + * @param[in] a The Eina_F16p16 number + * @param[in] b The integer value * @return The multiplication result of the two numbers @p a * @p b */ static inline Eina_F8p24 eina_f8p24_scale(Eina_F8p24 a, int b); @@ -409,8 +409,8 @@ static inline Eina_F8p24 eina_f8p24_scale(Eina_F8p24 a, int b); /** * @brief Calculates the division of two Eina_F8p24 floating point numbers * - * @param a The numerator number - * @param b The denominator number + * @param[in] a The numerator number + * @param[in] b The denominator number * @return The division result of the two numbers @p a / @p b */ static inline Eina_F8p24 eina_f8p24_div(Eina_F8p24 a, Eina_F8p24 b); @@ -418,7 +418,7 @@ static inline Eina_F8p24 eina_f8p24_div(Eina_F8p24 a, Eina_F8p24 b); /** * @brief Calculates the square root of an Eina_F8p24 floating point number * - * @param a The number to calculate the square root from + * @param[in] a The number to calculate the square root from * @return The square root result for the number @p a */ static inline Eina_F8p24 eina_f8p24_sqrt(Eina_F8p24 a); @@ -427,7 +427,7 @@ static inline Eina_F8p24 eina_f8p24_sqrt(Eina_F8p24 a); * @brief Gets the absolute value of the integer part of and Eina_F8p24 floating * point number * - * @param v The floating point number + * @param[in] v The floating point number * @return The positive integer part of the number @p v */ static inline unsigned int eina_f8p24_fracc_get(Eina_F8p24 v); @@ -435,7 +435,7 @@ static inline unsigned int eina_f8p24_fracc_get(Eina_F8p24 v); /** * @brief Converts an Eina_F16p16 floating point number into Eina_F32p32 format * - * @param a The Eina_F16p16 floating point number + * @param[in] a The Eina_F16p16 floating point number * @return The converted Eina_F32p32 floating point number */ static inline Eina_F32p32 eina_f16p16_to_f32p32(Eina_F16p16 a); @@ -443,7 +443,7 @@ static inline Eina_F32p32 eina_f16p16_to_f32p32(Eina_F16p16 a); /** * @brief Converts an Eina_F8p24 floating point number into Eina_F32p32 format * - * @param a The Eina_F8p24 floating point number + * @param[in] a The Eina_F8p24 floating point number * @return The converted Eina_F32p32 floating point number */ static inline Eina_F32p32 eina_f8p24_to_f32p32(Eina_F8p24 a); @@ -451,7 +451,7 @@ static inline Eina_F32p32 eina_f8p24_to_f32p32(Eina_F8p24 a); /** * @brief Converts an Eina_F32p32 floating point number into Eina_F16p16 format * - * @param a The Eina_F32p32 floating point number + * @param[in] a The Eina_F32p32 floating point number * @return The converted Eina_F16p16 floating point number */ static inline Eina_F16p16 eina_f32p32_to_f16p16(Eina_F32p32 a); @@ -459,7 +459,7 @@ static inline Eina_F16p16 eina_f32p32_to_f16p16(Eina_F32p32 a); /** * @brief Converts an Eina_F8p24 floating point number into Eina_F16p16 format * - * @param a The Eina_F8p24 floating point number + * @param[in] a The Eina_F8p24 floating point number * @return The converted Eina_F16p16 floating point number */ static inline Eina_F16p16 eina_f8p24_to_f16p16(Eina_F8p24 a); @@ -467,7 +467,7 @@ static inline Eina_F16p16 eina_f8p24_to_f16p16(Eina_F8p24 a); /** * @brief Converts an Eina_F32p32 floating point number into Eina_F8p24 format * - * @param a The Eina_F32p32 floating point number + * @param[in] a The Eina_F32p32 floating point number * @return The converted Eina_F8p16 floating point number */ static inline Eina_F8p24 eina_f32p32_to_f8p24(Eina_F32p32 a); @@ -475,7 +475,7 @@ static inline Eina_F8p24 eina_f32p32_to_f8p24(Eina_F32p32 a); /** * @brief Converts an Eina_F16p16 floating point number into Eina_F8p16 format * - * @param a The Eina_F16p16 floating point number + * @param[in] a The Eina_F16p16 floating point number * @return The converted Eina_F8p16 floating point number */ static inline Eina_F8p24 eina_f16p16_to_f8p24(Eina_F16p16 a); diff --git a/src/lib/eina/eina_freeq.h b/src/lib/eina/eina_freeq.h index b37da39517..a9c789c42e 100644 --- a/src/lib/eina/eina_freeq.h +++ b/src/lib/eina/eina_freeq.h @@ -132,7 +132,7 @@ eina_freeq_new(Eina_FreeQ_Type type); /** * @brief Free a free queue and anything that is queued in it. * - * @param fq The free queue to free and clear. + * @param[in,out] fq The free queue to free and clear. * * @since 1.19 */ @@ -142,7 +142,7 @@ eina_freeq_free(Eina_FreeQ *fq); /** * @brief Query the type of a free queue. * - * @param fq The free queue to inspect. + * @param[in] fq The free queue to inspect. * * @since 1.19 */ @@ -162,9 +162,9 @@ eina_freeq_main_get(void); /** * @brief Set the maximum number of free pointers this queue is allowed * - * @param fq The free queue to alter - * @param count The maximum number of items allowed, negative values mean - * no limit + * @param[in,out] fq The free queue to alter + * @param[in] count The maximum number of items allowed, negative values + * mean no limit * * This will alter the maximum number of pointers allowed in the given free * queue. If more items are added to the free queue than are allowed, @@ -183,7 +183,7 @@ eina_freeq_count_max_set(Eina_FreeQ *fq, int count); /** * @brief Get the maximum number of free pointers this queue is allowed * - * @param fq The free queue to query + * @param[in] fq The free queue to query * @return The maximum number of free items allowed or -1 for infinity * * @since 1.19 @@ -194,8 +194,8 @@ eina_freeq_count_max_get(Eina_FreeQ *fq); /** * @brief Set the maximum amount of memory allowed * - * @param fq The free queue to alter - * @param mem The maximum memory in bytes + * @param[in,out] fq The free queue to alter + * @param[in] mem The maximum memory in bytes * * This will alter the maximum amount of memory allowed for pointers stored * in the free queue. The size used is the size give, so items given that @@ -216,7 +216,7 @@ eina_freeq_mem_max_set(Eina_FreeQ *fq, size_t mem); /** * @brief Get the maximum amount of memory allowed * - * @param fq The free queue to query + * @param[in] fq The free queue to query * @return The maximum amount of memory in bytes * * @since 1.19 @@ -227,7 +227,7 @@ eina_freeq_mem_max_get(Eina_FreeQ *fq); /** * @brief Clear out all queued items to be freed by freeing them * - * @param fq The free queue to clear + * @param[in,out] fq The free queue to clear * * This will free and thus remove all queued items from the free queue when * this function is called. When it returns the free queue should be @@ -241,8 +241,8 @@ eina_freeq_clear(Eina_FreeQ *fq); /** * @brief Reduce the number of items in the free queue by up to @p count * - * @param fq The free queue to reduce in item count - * @param count The number of items to try and free + * @param[in,out] fq The free queue to reduce in item count + * @param[in] count The number of items to try and free * * This will attempt to free up to @p count items from the given free queue * and thus reduce the amount of memory it is holding on to. This function @@ -257,7 +257,7 @@ eina_freeq_reduce(Eina_FreeQ *fq, int count); /** * @brief Return if there are any items pending a free in the free queue * - * @param fq The free queue to query + * @param[in] fq The free queue to query * @raturn EINA_TRUE if there are items to free, EINA_FALSE otherwise * * @since 1.19 @@ -268,10 +268,10 @@ eina_freeq_ptr_pending(Eina_FreeQ *fq); /** * @brief Add a pointer with free function and size to the free queue * - * @param fq The free queue to add the pointer to - * @param ptr The pointer to free - * @param free_func The function used to free the pointer with - * @param size The size of the data the pointer points to + * @param[in,out] fq The free queue to add the pointer to + * @param[in] ptr The pointer to free + * @param[in] free_func The function used to free the pointer with + * @param[in] size The size of the data the pointer points to * * This adds the given @p ptr pointer to the queue to be freed later on. * The function @p free_func will be used, or if this is NULL, it is assumed @@ -312,9 +312,9 @@ eina_freeq_ptr_add(Eina_FreeQ *fq, void *ptr, void (*free_func) (void *ptr), siz /** * @brief Add a pointer to the main free queue * - * @param ptr The pointer to free - * @param free_func The function used to free the pointer with - * @param size The size of the data the pointer points to + * @param[in] ptr The pointer to free + * @param[in] free_func The function used to free the pointer with + * @param[in] size The size of the data the pointer points to * * This is the same as eina_freeq_ptr_add() but the main free queue is * fetched by eina_freeq_main_get(). @@ -330,7 +330,7 @@ eina_freeq_ptr_main_add(void *ptr, void (*free_func) (void *ptr), size_t size) /** * @brief Convenience macro for well known structures and types * - * @param ptr The pointer to free + * @param[in] ptr The pointer to free * * This is the same as eina_freeq_ptr_main_add() but the free function is * assumed to be the libc free() function, and size is provided by @@ -344,7 +344,7 @@ eina_freeq_ptr_main_add(void *ptr, void (*free_func) (void *ptr), size_t size) /** * @brief Convenience macro for well known structures and types * - * @param ptr The pointer to free + * @param[in] ptr The pointer to free * * This is the same as eina_freeq_ptr_main_add() but the free function is * assumed to be the libc free() function, and size is provided by