summaryrefslogtreecommitdiff
path: root/src/lib/eina
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2018-07-24 08:30:08 -0400
committerChris Michael <cp.michael@samsung.com>2018-07-24 08:30:08 -0400
commit6fb460845898298de9e693e277b6d943ede32413 (patch)
tree780f5b7025cb31732c99a706a28cabefdeece1e8 /src/lib/eina
parent5d78254c4576f869d7fb611038f89e20036ce2bb (diff)
eina: Add doxygen in/out tags for evlog, file, fp, freeq
Reviewers: devilhorns Reviewed By: devilhorns Subscribers: cedric, #committers, zmike Tags: #efl Differential Revision: https://phab.enlightenment.org/D6673
Diffstat (limited to 'src/lib/eina')
-rw-r--r--src/lib/eina/eina_evlog.h8
-rw-r--r--src/lib/eina/eina_file.h40
-rw-r--r--src/lib/eina/eina_file_common.h50
-rw-r--r--src/lib/eina/eina_fp.h118
-rw-r--r--src/lib/eina/eina_freeq.h44
5 files changed, 130 insertions, 130 deletions
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
106 * state at the time of the log events or a series of parameters and input 106 * state at the time of the log events or a series of parameters and input
107 * that caused this event. 107 * that caused this event.
108 * 108 *
109 * @param event The event string - see above for format 109 * @param[in] event The event string - see above for format
110 * @param obj An optional object "pointer" to associate 110 * @param[in] obj An optional object "pointer" to associate
111 * @param srctime An optional source event timestamp that caused this event 111 * @param[in] srctime An optional source event timestamp that caused this event
112 * @param detail An optional event detail string with more info 112 * @param[in] detail An optional event detail string with more info
113 * 113 *
114 * @since 1.15 114 * @since 1.15
115 */ 115 */
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;
105 * @typedef Eina_File_Dir_List_Cb 105 * @typedef Eina_File_Dir_List_Cb
106 * @brief Type for a callback to be called when iterating over the files of a 106 * @brief Type for a callback to be called when iterating over the files of a
107 * directory. 107 * directory.
108 * @param name The file name EXCLUDING the path 108 * @param[in] name The file name EXCLUDING the path
109 * @param path The path passed to eina_file_dir_list() 109 * @param[in] path The path passed to eina_file_dir_list()
110 * @param data The data passed to eina_file_dir_list() 110 * @param[in] data The data passed to eina_file_dir_list()
111 */ 111 */
112typedef void (*Eina_File_Dir_List_Cb)(const char *name, const char *path, void *data); 112typedef void (*Eina_File_Dir_List_Cb)(const char *name, const char *path, void *data);
113 113
@@ -240,7 +240,7 @@ struct _Eina_File_Line
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 * @details This macro casts @p function to #Eina_File_Dir_List_Cb. 242 * @details This macro casts @p function to #Eina_File_Dir_List_Cb.
243 * @param function The function to cast 243 * @param[in] function The function to cast
244 * 244 *
245 */ 245 */
246#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)
@@ -514,7 +514,7 @@ eina_file_virtualize(const char *virtual_name, const void *data, unsigned long l
514/** 514/**
515 * @brief Tells if a file is a real file or only exists in memory. 515 * @brief Tells if a file is a real file or only exists in memory.
516 * 516 *
517 * @param file The file to test 517 * @param[in] file The file to test
518 * @return #EINA_TRUE if the file is a virtual file 518 * @return #EINA_TRUE if the file is a virtual file
519 * 519 *
520 * @since 1.8 520 * @since 1.8
@@ -527,7 +527,7 @@ eina_file_virtual(Eina_File *file) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
527 * @details All current map continue to exist. You need to manually delete 527 * @details All current map continue to exist. You need to manually delete
528 * and recreate them to have the new correct mapping. 528 * and recreate them to have the new correct mapping.
529 * 529 *
530 * @param file The file to refresh 530 * @param[in,out] file The file to refresh
531 * @return #EINA_TRUE if the file has changed 531 * @return #EINA_TRUE if the file has changed
532 * 532 *
533 * @since 1.8 533 * @since 1.8
@@ -537,7 +537,7 @@ EAPI Eina_Bool eina_file_refresh(Eina_File *file);
537/** 537/**
538 * @brief Duplicates a read-only handler of a previously open file. 538 * @brief Duplicates a read-only handler of a previously open file.
539 * 539 *
540 * @param file To duplicate a reference to 540 * @param[in] file To duplicate a reference to
541 * @return #Eina_File handle of the duplicated file 541 * @return #Eina_File handle of the duplicated file
542 * 542 *
543 * @note Opens a file in read-only mode. 543 * @note Opens a file in read-only mode.
@@ -699,12 +699,12 @@ EAPI Eina_Bool eina_file_map_faulted(Eina_File *file, void *map);
699 * @details This function is similar to eina_str_join_len(), but the separator 699 * @details This function is similar to eina_str_join_len(), but the separator
700 * is '\' on Windows and '/' otherwise. 700 * is '\' on Windows and '/' otherwise.
701 * 701 *
702 * @param dst The buffer to store the result. 702 * @param[out] dst The buffer to store the result.
703 * @param size Size (in byte) of the buffer. 703 * @param[in] size Size (in byte) of the buffer.
704 * @param a First path to use. 704 * @param[in] a First path to use.
705 * @param a_len length of @p a. 705 * @param[in] a_len length of @p a.
706 * @param b Second path to use. 706 * @param[in] b Second path to use.
707 * @param b_len length of @p b. 707 * @param[in] b_len length of @p b.
708 * @return The number of characters printed. 708 * @return The number of characters printed.
709 * 709 *
710 * @see eina_str_join_len() 710 * @see eina_str_join_len()
@@ -725,10 +725,10 @@ static inline size_t eina_file_path_join_len(char *dst,
725 * the length of @p a and @p b using strlen(). The path separator is 725 * the length of @p a and @p b using strlen(). The path separator is
726 * '\' on Windows and '/' otherwise. 726 * '\' on Windows and '/' otherwise.
727 * 727 *
728 * @param dst The buffer to store the result. 728 * @param[out] dst The buffer to store the result.
729 * @param size Size (in byte) of the buffer. 729 * @param[in] size Size (in byte) of the buffer.
730 * @param a First string to use. 730 * @param[in] a First string to use.
731 * @param b Second string to use. 731 * @param[in] b Second string to use.
732 * @return The number of characters printed. 732 * @return The number of characters printed.
733 * 733 *
734 * @see eina_file_path_join_len() 734 * @see eina_file_path_join_len()
@@ -746,7 +746,7 @@ static inline size_t eina_file_path_join(char *dst,
746 * @details This function is a wrapper around the unlink() system call. It removes a link to 746 * @details This function is a wrapper around the unlink() system call. It removes a link to
747 * a file. 747 * a file.
748 * 748 *
749 * @param pathname File name to unlink. 749 * @param[in] pathname File name to unlink.
750 * @return #EINA_TRUE if the unlink was successful, #EINA_FALSE otherwise.. 750 * @return #EINA_TRUE if the unlink was successful, #EINA_FALSE otherwise..
751 * 751 *
752 * @since 1.19 752 * @since 1.19
@@ -758,8 +758,8 @@ EAPI Eina_Bool eina_file_unlink(const char *pathname);
758 * @details This function is a wrapper around the fnctl() system call. It makes sure 758 * @details This function is a wrapper around the fnctl() system call. It makes sure
759 * that the fd will be closed whenever exec is called. 759 * that the fd will be closed whenever exec is called.
760 * 760 *
761 * @param fd File descriptor to enforce close on exec on. 761 * @param[in] fd File descriptor to enforce close on exec on.
762 * @param on #EINA_TRUE will turn close on exec on, #EINA_FALSE will turn it off. 762 * @param[in] on #EINA_TRUE will turn close on exec on, #EINA_FALSE will turn it off.
763 * @return #EINA_TRUE if it will be closed on exec, #EINA_FALSE otherwise.. 763 * @return #EINA_TRUE if it will be closed on exec, #EINA_FALSE otherwise..
764 * 764 *
765 * @since 1.20 765 * @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
179 * The implementation simply checks if the first char in the path is '/'. If it 179 * The implementation simply checks if the first char in the path is '/'. If it
180 * is not, the path is considered relative. 180 * is not, the path is considered relative.
181 * 181 *
182 * @param path The path to check. 182 * @param[in] path The path to check.
183 183 *
184 * @return EINA_TRUE if the path is relative, EINA_FALSE otherwise. 184 * @return EINA_TRUE if the path is relative, EINA_FALSE otherwise.
185 * 185 *
186 */ 186 */
@@ -192,8 +192,8 @@ Eina_Bool eina_file_path_relative(const char *path);
192 * be appended to the current working directory. Presumably, this will be a 192 * be appended to the current working directory. Presumably, this will be a
193 * relative path. 193 * relative path.
194 * 194 *
195 * @param path The path to append to the current directory. 195 * @param[in] path The path to append to the current directory.
196 * @param len The length of @p path. 196 * @param[in] len The length of @p path.
197 * 197 *
198 * @return A pointer to a string that contains the absolute path to the current 198 * @return A pointer to a string that contains the absolute path to the current
199 * working directory plus any path you send in. 199 * 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);
204/** 204/**
205 * @brief Cleans up Eina after a file is no longer needed. 205 * @brief Cleans up Eina after a file is no longer needed.
206 * 206 *
207 * @param path The path of the file. 207 * @param[in,out] path The path of the file.
208 * 208 *
209 * @return On success, it will return the @p path string. If @p path is @c NULL, 209 * @return On success, it will return the @p path string. If @p path is @c NULL,
210 * it will return and empty string. 210 * it will return and empty string.
@@ -215,7 +215,7 @@ char *eina_file_cleanup(Eina_Tmpstr *path);
215/** 215/**
216 * @brief Closes and cleans up after an Eina file. 216 * @brief Closes and cleans up after an Eina file.
217 * 217 *
218 * @param file The path of the file. 218 * @param[in,out] file The path of the file.
219 * 219 *
220 */ 220 */
221void eina_file_clean_close(Eina_File *file); 221void eina_file_clean_close(Eina_File *file);
@@ -223,7 +223,7 @@ void eina_file_clean_close(Eina_File *file);
223/** 223/**
224 * @brief Closes a file from the OS perspective. 224 * @brief Closes a file from the OS perspective.
225 * 225 *
226 * @param file The path of the file. 226 * @param[in,out] file The path of the file.
227 * 227 *
228 */ 228 */
229void eina_file_real_close(Eina_File *file); 229void eina_file_real_close(Eina_File *file);
@@ -234,8 +234,8 @@ void eina_file_real_close(Eina_File *file);
234 * the memory maps for the file. If the file has shrunk, it also adds any mapped 234 * the memory maps for the file. If the file has shrunk, it also adds any mapped
235 * regions past the end of the file to the dead_map. 235 * regions past the end of the file to the dead_map.
236 * 236 *
237 * @param file The file. 237 * @param[in,out] file The file.
238 * @param length The current length of the file after the change. 238 * @param[in] length The current length of the file after the change.
239 * 239 *
240 */ 240 */
241void eina_file_flush(Eina_File *file, unsigned long int length); 241void 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);
247 * the map is part of the dead_map, @p free_func will be called to handle the actual 247 * the map is part of the dead_map, @p free_func will be called to handle the actual
248 * deallocation. 248 * deallocation.
249 * 249 *
250 * @param file The file. 250 * @param[in,out] file The file.
251 * @param map The memory mapped region that is to be freed. 251 * @param[in,out] map The memory mapped region that is to be freed.
252 * @param free_func A pointer to a function that will be called to free up the 252 * @param[in] free_func A pointer to a function that will be called to
253 * resources used by the map. 253 * free up the resources used by the map.
254 * 254 *
255 */ 255 */
256void eina_file_common_map_free(Eina_File *file, void *map, 256void eina_file_common_map_free(Eina_File *file, void *map,
@@ -277,9 +277,9 @@ void *eina_file_virtual_map_all(Eina_File *file);
277/** 277/**
278 * @brief Map a part of a virtual file to a buffer. 278 * @brief Map a part of a virtual file to a buffer.
279 * 279 *
280 * @param file The virtual file to map in memory 280 * @param[in,out] file The virtual file to map in memory
281 * @param offset The offset inside the file to start mapping 281 * @param[in] offset The offset inside the file to start mapping
282 * @param length The length of the region to map 282 * @param[in] length The length of the region to map
283 * 283 *
284 */ 284 */
285void *eina_file_virtual_map_new(Eina_File *file, 285void *eina_file_virtual_map_new(Eina_File *file,
@@ -288,8 +288,8 @@ void *eina_file_virtual_map_new(Eina_File *file,
288/** 288/**
289 * @brief Unref and unmap memory if possible. 289 * @brief Unref and unmap memory if possible.
290 * 290 *
291 * @param file The file handler to unmap memory from. 291 * @param[in,out] file The file handler to unmap memory from.
292 * @param map Memory map to unref and unmap. 292 * @param[in,out] map Memory map to unref and unmap.
293 * 293 *
294 */ 294 */
295void eina_file_virtual_map_free(Eina_File *file, void *map); 295void 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);
300 * @warning This function is not yet implemented. At present it only returns 300 * @warning This function is not yet implemented. At present it only returns
301 * @code sizeof (unsigned long int) * 2 @endcode 301 * @code sizeof (unsigned long int) * 2 @endcode
302 * 302 *
303 * @param key The key for which length will be calculated. 303 * @param[in] key The key for which length will be calculated.
304 * 304 *
305 * @return The length of the key. 305 * @return The length of the key.
306 * 306 *
@@ -312,10 +312,10 @@ unsigned int eina_file_map_key_length(const void *key);
312 * The implementation assumes that @p key1 and @p key2 are both pointers to an 312 * The implementation assumes that @p key1 and @p key2 are both pointers to an
313 * array with 2 elements, as is the case with the Eina file map keys. 313 * array with 2 elements, as is the case with the Eina file map keys.
314 * 314 *
315 * @param key1 The first key. 315 * @param[in] key1 The first key.
316 * @param key1_length The length of the first key. 316 * @param[in] key1_length The length of the first key.
317 * @param key2 The second key. 317 * @param[in] key2 The second key.
318 * @param key2_length The length of the second key. 318 * @param[in] key2_length The length of the second key.
319 * 319 *
320 * @return Positive number if Key1 > Key2, else a negative number. Will return 320 * @return Positive number if Key1 > Key2, else a negative number. Will return
321 * zero if both elements of the key are exactly the same. 321 * 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,
327/** 327/**
328 * @brief Creates a hash from a map key. 328 * @brief Creates a hash from a map key.
329 * 329 *
330 * @param key A pointer to the key. 330 * @param[in] key A pointer to the key.
331 * @param key_length The length of the key. 331 * @param[in] key_length The length of the key.
332 * 332 *
333 * @return A key hash. 333 * @return A key hash.
334 * 334 *
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;
79 * @brief Creates 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[in] v 32-bit integer value to convert
83 * @return The value converted into Eina_F32p32 format 83 * @return The value converted into Eina_F32p32 format
84 */ 84 */
85static inline Eina_F32p32 eina_f32p32_int_from(int32_t v); 85static 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);
88 * @brief Creates 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[in] v Eina_F32p32 value to convert
92 * @return The value converted into 32-bit integer 92 * @return The value converted into 32-bit integer
93 */ 93 */
94static inline int32_t eina_f32p32_int_to(Eina_F32p32 v); 94static 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);
96/** 96/**
97 * @brief Creates 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[in] 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);
@@ -105,7 +105,7 @@ static inline Eina_F32p32 eina_f32p32_double_from(double v);
105 * @brief Creates 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[in] v Eina_F32p32 value to convert
109 * @return The value converted into double 109 * @return The value converted into double
110 */ 110 */
111static inline double eina_f32p32_double_to(Eina_F32p32 v); 111static inline double eina_f32p32_double_to(Eina_F32p32 v);
@@ -113,8 +113,8 @@ static inline double eina_f32p32_double_to(Eina_F32p32 v);
113/** 113/**
114 * @brief Calculates the sum of two Eina_F32p32 floating point numbers 114 * @brief Calculates the sum of two Eina_F32p32 floating point numbers
115 * 115 *
116 * @param a The first number 116 * @param[in] a The first number
117 * @param b The second number 117 * @param[in] b The second number
118 * @return The sum result of the two numbers @p a + @p b 118 * @return The sum result of the two numbers @p a + @p b
119 */ 119 */
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);
@@ -122,8 +122,8 @@ static inline Eina_F32p32 eina_f32p32_add(Eina_F32p32 a, Eina_F32p32 b);
122/** 122/**
123 * @brief Calculates the subtraction 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[in] a The first number
126 * @param b The subtracted number 126 * @param[in] b The subtracted number
127 * @return The subtraction 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);
@@ -131,8 +131,8 @@ static inline Eina_F32p32 eina_f32p32_sub(Eina_F32p32 a, Eina_F32p32 b);
131/** 131/**
132 * @brief Calculates the multiplication of two Eina_F32p32 floating point numbers 132 * @brief Calculates the multiplication of two Eina_F32p32 floating point numbers
133 * 133 *
134 * @param a The first number 134 * @param[in] a The first number
135 * @param b The second number 135 * @param[in] b The second number
136 * @return The multiplication 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
@@ -146,8 +146,8 @@ static inline Eina_F32p32 eina_f32p32_mul(Eina_F32p32 a, Eina_F32p32 b);
146 * @brief Calculates the scale multiplication of one Eina_F32p32 floating point 146 * @brief Calculates the scale multiplication of one Eina_F32p32 floating point
147 * number with an integer 147 * number with an integer
148 * 148 *
149 * @param a The Eina_F32p32 number 149 * @param[in] a The Eina_F32p32 number
150 * @param b The integer value 150 * @param[in] b The integer value
151 * @return The multiplication 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);
@@ -155,8 +155,8 @@ static inline Eina_F32p32 eina_f32p32_scale(Eina_F32p32 a, int b);
155/** 155/**
156 * @brief Calculates the division of two Eina_F32p32 floating point numbers 156 * @brief Calculates the division of two Eina_F32p32 floating point numbers
157 * 157 *
158 * @param a The numerator number 158 * @param[in] a The numerator number
159 * @param b The denominator number 159 * @param[in] b The denominator number
160 * @return The division result of the two numbers @p a / @p b 160 * @return The division result of the two numbers @p a / @p b
161 */ 161 */
162static inline Eina_F32p32 eina_f32p32_div(Eina_F32p32 a, Eina_F32p32 b); 162static 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);
164/** 164/**
165 * @brief Calculates the square root of an Eina_F32p32 floating point number 165 * @brief Calculates the square root of an Eina_F32p32 floating point number
166 * 166 *
167 * @param a The number to calculate the square root from 167 * @param[in] a The number to calculate the square root from
168 * @return The square root result for the number @p a 168 * @return The square root result for the number @p a
169 */ 169 */
170static inline Eina_F32p32 eina_f32p32_sqrt(Eina_F32p32 a); 170static inline Eina_F32p32 eina_f32p32_sqrt(Eina_F32p32 a);
@@ -173,7 +173,7 @@ static inline Eina_F32p32 eina_f32p32_sqrt(Eina_F32p32 a);
173 * @brief Gets 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[in] v The floating point number
177 * @return The positive integer part of the number @p v 177 * @return The positive integer part of the number @p v
178 */ 178 */
179static inline unsigned int eina_f32p32_fracc_get(Eina_F32p32 v); 179static 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);
181/** 181/**
182 * @brief Gets 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[in] 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
186 * @warning Has known issues on 64-bit architecture, prefer 186 * @warning Has known issues on 64-bit architecture, prefer
187 * eina_f32p32_fracc_get() instead 187 * eina_f32p32_fracc_get() instead
@@ -191,7 +191,7 @@ static inline unsigned int eina_f32p32_fracc_get(Eina_F32p32 v);
191/** 191/**
192 * @brief Calculates the cosinus of a floating point number 192 * @brief Calculates the cosinus of a floating point number
193 * 193 *
194 * @param a The angle in radians to calculate the cosinus from. 194 * @param[in] a The angle in radians to calculate the cosinus from.
195 * @return The cosinus value of the angle @p a 195 * @return The cosinus value of the angle @p a
196 */ 196 */
197EAPI Eina_F32p32 eina_f32p32_cos(Eina_F32p32 a); 197EAPI Eina_F32p32 eina_f32p32_cos(Eina_F32p32 a);
@@ -199,7 +199,7 @@ EAPI Eina_F32p32 eina_f32p32_cos(Eina_F32p32 a);
199/** 199/**
200 * @brief Calculates the sinus of a floating point number 200 * @brief Calculates the sinus of a floating point number
201 * 201 *
202 * @param a The angle in radians to calculate the sinus from. 202 * @param[in] a The angle in radians to calculate the sinus from.
203 * @return The cosinus value of the angle @p a 203 * @return The cosinus value of the angle @p a
204 */ 204 */
205EAPI Eina_F32p32 eina_f32p32_sin(Eina_F32p32 a); 205EAPI Eina_F32p32 eina_f32p32_sin(Eina_F32p32 a);
@@ -223,7 +223,7 @@ EAPI Eina_F32p32 eina_f32p32_sin(Eina_F32p32 a);
223 * @brief Creates 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[in] v 32-bit integer value to convert
227 * @return The value converted into Eina_F16p16 format 227 * @return The value converted into Eina_F16p16 format
228 */ 228 */
229static inline Eina_F16p16 eina_f16p16_int_from(int32_t v); 229static 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);
232 * @brief Creates 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[in] v Eina_F16p16 value to convert
236 * @return The value converted into 32-bit integer 236 * @return The value converted into 32-bit integer
237 */ 237 */
238static inline int32_t eina_f16p16_int_to(Eina_F16p16 v); 238static 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);
240/** 240/**
241 * @brief Creates 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[in] 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);
@@ -249,7 +249,7 @@ static inline Eina_F16p16 eina_f16p16_double_from(double v);
249 * @brief Creates 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[in] v Eina_F16p16 value to convert
253 * @return The value converted into double 253 * @return The value converted into double
254 */ 254 */
255static inline double eina_f16p16_double_to(Eina_F16p16 v); 255static inline double eina_f16p16_double_to(Eina_F16p16 v);
@@ -257,7 +257,7 @@ static inline double eina_f16p16_double_to(Eina_F16p16 v);
257/** 257/**
258 * @brief Creates 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[in] 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);
@@ -266,7 +266,7 @@ static inline Eina_F16p16 eina_f16p16_float_from(float v);
266 * @brief Creates 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[in] v Eina_F16p16 value to convert
270 * @return The value converted into float 270 * @return The value converted into float
271 */ 271 */
272static inline float eina_f16p16_float_to(Eina_F16p16 v); 272static inline float eina_f16p16_float_to(Eina_F16p16 v);
@@ -274,8 +274,8 @@ static inline float eina_f16p16_float_to(Eina_F16p16 v);
274/** 274/**
275 * @brief Calculates the sum of two Eina_F16p16 floating point numbers 275 * @brief Calculates the sum of two Eina_F16p16 floating point numbers
276 * 276 *
277 * @param a The first number 277 * @param[in] a The first number
278 * @param b The second number 278 * @param[in] b The second number
279 * @return The sum result of the two numbers @p a + @p b 279 * @return The sum result of the two numbers @p a + @p b
280 */ 280 */
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);
@@ -283,8 +283,8 @@ static inline Eina_F16p16 eina_f16p16_add(Eina_F16p16 a, Eina_F16p16 b);
283/** 283/**
284 * @brief Calculates the subtraction 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[in] a The first number
287 * @param b The subtracted number 287 * @param[in] b The subtracted number
288 * @return The subtraction 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);
@@ -292,8 +292,8 @@ static inline Eina_F16p16 eina_f16p16_sub(Eina_F16p16 a, Eina_F16p16 b);
292/** 292/**
293 * @brief Calculates the multiplication of two Eina_F16p16 floating point numbers 293 * @brief Calculates the multiplication of two Eina_F16p16 floating point numbers
294 * 294 *
295 * @param a The first number 295 * @param[in] a The first number
296 * @param b The second number 296 * @param[in] b The second number
297 * @return The multiplication 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);
@@ -302,8 +302,8 @@ static inline Eina_F16p16 eina_f16p16_mul(Eina_F16p16 a, Eina_F16p16 b);
302 * @brief Calculates the scale multiplication of one Eina_F16p16 floating point 302 * @brief Calculates the scale multiplication of one Eina_F16p16 floating point
303 * number with an integer 303 * number with an integer
304 * 304 *
305 * @param a The Eina_F16p16 number 305 * @param[in] a The Eina_F16p16 number
306 * @param b The integer value 306 * @param[in] b The integer value
307 * @return The multiplication 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);
@@ -311,8 +311,8 @@ static inline Eina_F16p16 eina_f16p16_scale(Eina_F16p16 a, int b);
311/** 311/**
312 * @brief Calculates the division of two Eina_F16p16 floating point numbers 312 * @brief Calculates the division of two Eina_F16p16 floating point numbers
313 * 313 *
314 * @param a The numerator number 314 * @param[in] a The numerator number
315 * @param b The denominator number 315 * @param[in] b The denominator number
316 * @return The division result of the two numbers @p a / @p b 316 * @return The division result of the two numbers @p a / @p b
317 */ 317 */
318static inline Eina_F16p16 eina_f16p16_div(Eina_F16p16 a, Eina_F16p16 b); 318static 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);
320/** 320/**
321 * @brief Calculates the square root of an Eina_F16p16 floating point number 321 * @brief Calculates the square root of an Eina_F16p16 floating point number
322 * 322 *
323 * @param a The number to calculate the square root from 323 * @param[in] a The number to calculate the square root from
324 * @return The square root result for the number @p a 324 * @return The square root result for the number @p a
325 */ 325 */
326static inline Eina_F16p16 eina_f16p16_sqrt(Eina_F16p16 a); 326static inline Eina_F16p16 eina_f16p16_sqrt(Eina_F16p16 a);
@@ -329,7 +329,7 @@ static inline Eina_F16p16 eina_f16p16_sqrt(Eina_F16p16 a);
329 * @brief Gets 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[in] v The floating point number
333 * @return The positive integer part of the number @p v 333 * @return The positive integer part of the number @p v
334 */ 334 */
335static inline unsigned int eina_f16p16_fracc_get(Eina_F16p16 v); 335static 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);
339 * @brief Creates 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[in] v 32-bit integer value to convert
343 * @return The value converted into Eina_F8p24 format 343 * @return The value converted into Eina_F8p24 format
344 */ 344 */
345static inline Eina_F8p24 eina_f8p24_int_from(int32_t v); 345static 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);
348 * @brief Creates 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[in] v Eina_F8p24 value to convert
352 * @return The value converted into 32-bit integer 352 * @return The value converted into 32-bit integer
353 */ 353 */
354static inline int32_t eina_f8p24_int_to(Eina_F8p24 v); 354static 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);
356/** 356/**
357 * @brief Creates 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[in] 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);
@@ -364,7 +364,7 @@ static inline Eina_F8p24 eina_f8p24_float_from(float v);
364/** 364/**
365 * @brief Create a new standard float from Eina_F8p24 floating point number 365 * @brief Create a new standard float from Eina_F8p24 floating point number
366 * 366 *
367 * @param v Eina_F8p24 value to convert 367 * @param[in] v Eina_F8p24 value to convert
368 * @return The value converted into float 368 * @return The value converted into float
369 */ 369 */
370static inline float eina_f8p24_float_to(Eina_F8p24 v); 370static inline float eina_f8p24_float_to(Eina_F8p24 v);
@@ -372,8 +372,8 @@ static inline float eina_f8p24_float_to(Eina_F8p24 v);
372/** 372/**
373 * @brief Calculates the sum of two Eina_F8p24 floating point numbers 373 * @brief Calculates the sum of two Eina_F8p24 floating point numbers
374 * 374 *
375 * @param a The first number 375 * @param[in] a The first number
376 * @param b The second number 376 * @param[in] b The second number
377 * @return The sum result of the two numbers @p a + @p b 377 * @return The sum result of the two numbers @p a + @p b
378 */ 378 */
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);
@@ -381,8 +381,8 @@ static inline Eina_F8p24 eina_f8p24_add(Eina_F8p24 a, Eina_F8p24 b);
381/** 381/**
382 * @brief Calculates the subtraction 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[in] a The first number
385 * @param b The subtracted number 385 * @param[in] b The subtracted number
386 * @return The subtraction 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);
@@ -390,8 +390,8 @@ static inline Eina_F8p24 eina_f8p24_sub(Eina_F8p24 a, Eina_F8p24 b);
390/** 390/**
391 * @brief Calculates the multiplication of two Eina_F8p24 floating point numbers 391 * @brief Calculates the multiplication of two Eina_F8p24 floating point numbers
392 * 392 *
393 * @param a The first number 393 * @param[in] a The first number
394 * @param b The second number 394 * @param[in] b The second number
395 * @return The multiplication 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);
@@ -400,8 +400,8 @@ static inline Eina_F8p24 eina_f8p24_mul(Eina_F8p24 a, Eina_F8p24 b);
400 * @brief Calculates the scale multiplication of one Eina_F8p24 floating point 400 * @brief Calculates the scale multiplication of one Eina_F8p24 floating point
401 * number with an integer 401 * number with an integer
402 * 402 *
403 * @param a The Eina_F16p16 number 403 * @param[in] a The Eina_F16p16 number
404 * @param b The integer value 404 * @param[in] b The integer value
405 * @return The multiplication 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);
@@ -409,8 +409,8 @@ static inline Eina_F8p24 eina_f8p24_scale(Eina_F8p24 a, int b);
409/** 409/**
410 * @brief Calculates the division of two Eina_F8p24 floating point numbers 410 * @brief Calculates the division of two Eina_F8p24 floating point numbers
411 * 411 *
412 * @param a The numerator number 412 * @param[in] a The numerator number
413 * @param b The denominator number 413 * @param[in] b The denominator number
414 * @return The division result of the two numbers @p a / @p b 414 * @return The division result of the two numbers @p a / @p b
415 */ 415 */
416static inline Eina_F8p24 eina_f8p24_div(Eina_F8p24 a, Eina_F8p24 b); 416static 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);
418/** 418/**
419 * @brief Calculates the square root of an Eina_F8p24 floating point number 419 * @brief Calculates the square root of an Eina_F8p24 floating point number
420 * 420 *
421 * @param a The number to calculate the square root from 421 * @param[in] a The number to calculate the square root from
422 * @return The square root result for the number @p a 422 * @return The square root result for the number @p a
423 */ 423 */
424static inline Eina_F8p24 eina_f8p24_sqrt(Eina_F8p24 a); 424static inline Eina_F8p24 eina_f8p24_sqrt(Eina_F8p24 a);
@@ -427,7 +427,7 @@ static inline Eina_F8p24 eina_f8p24_sqrt(Eina_F8p24 a);
427 * @brief Gets 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[in] v The floating point number
431 * @return The positive integer part of the number @p v 431 * @return The positive integer part of the number @p v
432 */ 432 */
433static inline unsigned int eina_f8p24_fracc_get(Eina_F8p24 v); 433static 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);
435/** 435/**
436 * @brief Converts an Eina_F16p16 floating point number into Eina_F32p32 format 436 * @brief Converts an Eina_F16p16 floating point number into Eina_F32p32 format
437 * 437 *
438 * @param a The Eina_F16p16 floating point number 438 * @param[in] a The Eina_F16p16 floating point number
439 * @return The converted Eina_F32p32 floating point number 439 * @return The converted Eina_F32p32 floating point number
440 */ 440 */
441static inline Eina_F32p32 eina_f16p16_to_f32p32(Eina_F16p16 a); 441static 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);
443/** 443/**
444 * @brief Converts an Eina_F8p24 floating point number into Eina_F32p32 format 444 * @brief Converts an Eina_F8p24 floating point number into Eina_F32p32 format
445 * 445 *
446 * @param a The Eina_F8p24 floating point number 446 * @param[in] a The Eina_F8p24 floating point number
447 * @return The converted Eina_F32p32 floating point number 447 * @return The converted Eina_F32p32 floating point number
448 */ 448 */
449static inline Eina_F32p32 eina_f8p24_to_f32p32(Eina_F8p24 a); 449static 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);
451/** 451/**
452 * @brief Converts an Eina_F32p32 floating point number into Eina_F16p16 format 452 * @brief Converts an Eina_F32p32 floating point number into Eina_F16p16 format
453 * 453 *
454 * @param a The Eina_F32p32 floating point number 454 * @param[in] a The Eina_F32p32 floating point number
455 * @return The converted Eina_F16p16 floating point number 455 * @return The converted Eina_F16p16 floating point number
456 */ 456 */
457static inline Eina_F16p16 eina_f32p32_to_f16p16(Eina_F32p32 a); 457static 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);
459/** 459/**
460 * @brief Converts an Eina_F8p24 floating point number into Eina_F16p16 format 460 * @brief Converts an Eina_F8p24 floating point number into Eina_F16p16 format
461 * 461 *
462 * @param a The Eina_F8p24 floating point number 462 * @param[in] a The Eina_F8p24 floating point number
463 * @return The converted Eina_F16p16 floating point number 463 * @return The converted Eina_F16p16 floating point number
464 */ 464 */
465static inline Eina_F16p16 eina_f8p24_to_f16p16(Eina_F8p24 a); 465static 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);
467/** 467/**
468 * @brief Converts an Eina_F32p32 floating point number into Eina_F8p24 format 468 * @brief Converts an Eina_F32p32 floating point number into Eina_F8p24 format
469 * 469 *
470 * @param a The Eina_F32p32 floating point number 470 * @param[in] a The Eina_F32p32 floating point number
471 * @return The converted Eina_F8p16 floating point number 471 * @return The converted Eina_F8p16 floating point number
472 */ 472 */
473static inline Eina_F8p24 eina_f32p32_to_f8p24(Eina_F32p32 a); 473static 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);
475/** 475/**
476 * @brief Converts an Eina_F16p16 floating point number into Eina_F8p16 format 476 * @brief Converts an Eina_F16p16 floating point number into Eina_F8p16 format
477 * 477 *
478 * @param a The Eina_F16p16 floating point number 478 * @param[in] a The Eina_F16p16 floating point number
479 * @return The converted Eina_F8p16 floating point number 479 * @return The converted Eina_F8p16 floating point number
480 */ 480 */
481static inline Eina_F8p24 eina_f16p16_to_f8p24(Eina_F16p16 a); 481static 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);
132/** 132/**
133 * @brief Free a free queue and anything that is queued in it. 133 * @brief Free a free queue and anything that is queued in it.
134 * 134 *
135 * @param fq The free queue to free and clear. 135 * @param[in,out] fq The free queue to free and clear.
136 * 136 *
137 * @since 1.19 137 * @since 1.19
138 */ 138 */
@@ -142,7 +142,7 @@ eina_freeq_free(Eina_FreeQ *fq);
142/** 142/**
143 * @brief Query the type of a free queue. 143 * @brief Query the type of a free queue.
144 * 144 *
145 * @param fq The free queue to inspect. 145 * @param[in] fq The free queue to inspect.
146 * 146 *
147 * @since 1.19 147 * @since 1.19
148 */ 148 */
@@ -162,9 +162,9 @@ eina_freeq_main_get(void);
162/** 162/**
163 * @brief Set the maximum number of free pointers this queue is allowed 163 * @brief Set the maximum number of free pointers this queue is allowed
164 * 164 *
165 * @param fq The free queue to alter 165 * @param[in,out] fq The free queue to alter
166 * @param count The maximum number of items allowed, negative values mean 166 * @param[in] count The maximum number of items allowed, negative values
167 * no limit 167 * mean no limit
168 * 168 *
169 * This will alter the maximum number of pointers allowed in the given free 169 * This will alter the maximum number of pointers allowed in the given free
170 * queue. If more items are added to the free queue than are allowed, 170 * 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);
183/** 183/**
184 * @brief Get the maximum number of free pointers this queue is allowed 184 * @brief Get the maximum number of free pointers this queue is allowed
185 * 185 *
186 * @param fq The free queue to query 186 * @param[in] fq The free queue to query
187 * @return The maximum number of free items allowed or -1 for infinity 187 * @return The maximum number of free items allowed or -1 for infinity
188 * 188 *
189 * @since 1.19 189 * @since 1.19
@@ -194,8 +194,8 @@ eina_freeq_count_max_get(Eina_FreeQ *fq);
194/** 194/**
195 * @brief Set the maximum amount of memory allowed 195 * @brief Set the maximum amount of memory allowed
196 * 196 *
197 * @param fq The free queue to alter 197 * @param[in,out] fq The free queue to alter
198 * @param mem The maximum memory in bytes 198 * @param[in] mem The maximum memory in bytes
199 * 199 *
200 * This will alter the maximum amount of memory allowed for pointers stored 200 * This will alter the maximum amount of memory allowed for pointers stored
201 * in the free queue. The size used is the size give, so items given that 201 * 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);
216/** 216/**
217 * @brief Get the maximum amount of memory allowed 217 * @brief Get the maximum amount of memory allowed
218 * 218 *
219 * @param fq The free queue to query 219 * @param[in] fq The free queue to query
220 * @return The maximum amount of memory in bytes 220 * @return The maximum amount of memory in bytes
221 * 221 *
222 * @since 1.19 222 * @since 1.19
@@ -227,7 +227,7 @@ eina_freeq_mem_max_get(Eina_FreeQ *fq);
227/** 227/**
228 * @brief Clear out all queued items to be freed by freeing them 228 * @brief Clear out all queued items to be freed by freeing them
229 * 229 *
230 * @param fq The free queue to clear 230 * @param[in,out] fq The free queue to clear
231 * 231 *
232 * This will free and thus remove all queued items from the free queue when 232 * This will free and thus remove all queued items from the free queue when
233 * this function is called. When it returns the free queue should be 233 * this function is called. When it returns the free queue should be
@@ -241,8 +241,8 @@ eina_freeq_clear(Eina_FreeQ *fq);
241/** 241/**
242 * @brief Reduce the number of items in the free queue by up to @p count 242 * @brief Reduce the number of items in the free queue by up to @p count
243 * 243 *
244 * @param fq The free queue to reduce in item count 244 * @param[in,out] fq The free queue to reduce in item count
245 * @param count The number of items to try and free 245 * @param[in] count The number of items to try and free
246 * 246 *
247 * This will attempt to free up to @p count items from the given free queue 247 * This will attempt to free up to @p count items from the given free queue
248 * and thus reduce the amount of memory it is holding on to. This function 248 * 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);
257/** 257/**
258 * @brief Return if there are any items pending a free in the free queue 258 * @brief Return if there are any items pending a free in the free queue
259 * 259 *
260 * @param fq The free queue to query 260 * @param[in] fq The free queue to query
261 * @raturn EINA_TRUE if there are items to free, EINA_FALSE otherwise 261 * @raturn EINA_TRUE if there are items to free, EINA_FALSE otherwise
262 * 262 *
263 * @since 1.19 263 * @since 1.19
@@ -268,10 +268,10 @@ eina_freeq_ptr_pending(Eina_FreeQ *fq);
268/** 268/**
269 * @brief Add a pointer with free function and size to the free queue 269 * @brief Add a pointer with free function and size to the free queue
270 * 270 *
271 * @param fq The free queue to add the pointer to 271 * @param[in,out] fq The free queue to add the pointer to
272 * @param ptr The pointer to free 272 * @param[in] ptr The pointer to free
273 * @param free_func The function used to free the pointer with 273 * @param[in] free_func The function used to free the pointer with
274 * @param size The size of the data the pointer points to 274 * @param[in] size The size of the data the pointer points to
275 * 275 *
276 * This adds the given @p ptr pointer to the queue to be freed later on. 276 * This adds the given @p ptr pointer to the queue to be freed later on.
277 * The function @p free_func will be used, or if this is NULL, it is assumed 277 * 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
312/** 312/**
313 * @brief Add a pointer to the main free queue 313 * @brief Add a pointer to the main free queue
314 * 314 *
315 * @param ptr The pointer to free 315 * @param[in] ptr The pointer to free
316 * @param free_func The function used to free the pointer with 316 * @param[in] free_func The function used to free the pointer with
317 * @param size The size of the data the pointer points to 317 * @param[in] size The size of the data the pointer points to
318 * 318 *
319 * This is the same as eina_freeq_ptr_add() but the main free queue is 319 * This is the same as eina_freeq_ptr_add() but the main free queue is
320 * fetched by eina_freeq_main_get(). 320 * 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)
330/** 330/**
331 * @brief Convenience macro for well known structures and types 331 * @brief Convenience macro for well known structures and types
332 * 332 *
333 * @param ptr The pointer to free 333 * @param[in] ptr The pointer to free
334 * 334 *
335 * This is the same as eina_freeq_ptr_main_add() but the free function is 335 * This is the same as eina_freeq_ptr_main_add() but the free function is
336 * assumed to be the libc free() function, and size is provided by 336 * 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)
344/** 344/**
345 * @brief Convenience macro for well known structures and types 345 * @brief Convenience macro for well known structures and types
346 * 346 *
347 * @param ptr The pointer to free 347 * @param[in] ptr The pointer to free
348 * 348 *
349 * This is the same as eina_freeq_ptr_main_add() but the free function is 349 * This is the same as eina_freeq_ptr_main_add() but the free function is
350 * assumed to be the libc free() function, and size is provided by 350 * assumed to be the libc free() function, and size is provided by