summaryrefslogtreecommitdiff
path: root/src/lib/eina
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2018-07-18 15:21:07 +0900
committerHermet Park <hermetpark@gmail.com>2018-07-18 15:21:07 +0900
commit096c01a818bc8d0a0ddcfa3163163f5f97d24253 (patch)
treee4b911a00723767a916e3ff53c886e62780155e8 /src/lib/eina
parent268d3fcef57a795e209dbd597162fc59d4623b55 (diff)
eina: Add doxygen in/out tags
Reviewers: Hermet Reviewed By: Hermet Subscribers: cedric, #committers, zmike Tags: #efl Differential Revision: https://phab.enlightenment.org/D6624
Diffstat (limited to 'src/lib/eina')
-rw-r--r--src/lib/eina/eina_alloca.h3
-rw-r--r--src/lib/eina/eina_benchmark.h22
-rw-r--r--src/lib/eina/eina_binshare.h6
-rw-r--r--src/lib/eina/eina_convert.h31
-rw-r--r--src/lib/eina/eina_quad.h44
5 files changed, 53 insertions, 53 deletions
diff --git a/src/lib/eina/eina_alloca.h b/src/lib/eina/eina_alloca.h
index db6a3945a6..5950e2386a 100644
--- a/src/lib/eina/eina_alloca.h
+++ b/src/lib/eina/eina_alloca.h
@@ -42,11 +42,12 @@
42# ifdef __cplusplus 42# ifdef __cplusplus
43extern "C" 43extern "C"
44# endif 44# endif
45
45/** 46/**
46 * @brief Allocates memory in the stack frame of the caller, so that it 47 * @brief Allocates memory in the stack frame of the caller, so that it
47 * is automatically freed when the caller returns. 48 * is automatically freed when the caller returns.
48 * 49 *
49 * @param size Number of bytes of space to allocate. 50 * @param[in] size Number of bytes of space to allocate.
50 * @return Pointer to beginning of the allocated space. 51 * @return Pointer to beginning of the allocated space.
51 * 52 *
52 * @see alloca(3) for more details. 53 * @see alloca(3) for more details.
diff --git a/src/lib/eina/eina_benchmark.h b/src/lib/eina/eina_benchmark.h
index 8971b255b6..38959a1306 100644
--- a/src/lib/eina/eina_benchmark.h
+++ b/src/lib/eina/eina_benchmark.h
@@ -346,7 +346,7 @@ typedef void (*Eina_Benchmark_Specimens)(int request);
346 * @def EINA_BENCHMARK 346 * @def EINA_BENCHMARK
347 * @brief Definition for the cast to an #Eina_Benchmark_Specimens. 347 * @brief Definition for the cast to an #Eina_Benchmark_Specimens.
348 * 348 *
349 * @param function The function to cast. 349 * @param[in] function The function to cast.
350 * 350 *
351 * This macro casts @p function to Eina_Benchmark_Specimens. 351 * This macro casts @p function to Eina_Benchmark_Specimens.
352 */ 352 */
@@ -356,8 +356,8 @@ typedef void (*Eina_Benchmark_Specimens)(int request);
356/** 356/**
357 * @brief Creates a new array. 357 * @brief Creates a new array.
358 * 358 *
359 * @param name The name of the benchmark. 359 * @param[in] name The name of the benchmark.
360 * @param run The name of the run. 360 * @param[in] run The name of the run.
361 * @return A valid benchmark on success, or @c NULL on memory allocation 361 * @return A valid benchmark on success, or @c NULL on memory allocation
362 * failure. 362 * failure.
363 * 363 *
@@ -373,7 +373,7 @@ EAPI Eina_Benchmark *eina_benchmark_new(const char *name,
373/** 373/**
374 * @brief Frees a benchmark object. 374 * @brief Frees a benchmark object.
375 * 375 *
376 * @param bench The benchmark to free. 376 * @param[in,out] bench The benchmark to free.
377 * 377 *
378 * This function removes all the benchmark tests that have been 378 * This function removes all the benchmark tests that have been
379 * registered and frees @p bench. If @p bench is @c NULL, this 379 * registered and frees @p bench. If @p bench is @c NULL, this
@@ -384,12 +384,12 @@ EAPI void eina_benchmark_free(Eina_Benchmark *bench);
384/** 384/**
385 * @brief Adds a test to a benchmark. 385 * @brief Adds a test to a benchmark.
386 * 386 *
387 * @param bench The benchmark. 387 * @param[in,out] bench The benchmark.
388 * @param name The name of the test. 388 * @param[in] name The name of the test.
389 * @param bench_cb The test function to be called. 389 * @param[in] bench_cb The test function to be called.
390 * @param count_start The start data to be passed to @p bench_cb. 390 * @param[in] count_start The start data to be passed to @p bench_cb.
391 * @param count_end The end data to be passed to @p bench_cb. 391 * @param[in] count_end The end data to be passed to @p bench_cb.
392 * @param count_step The step data to be passed to @p bench_cb. 392 * @param[in] count_step The step data to be passed to @p bench_cb.
393 * @return #EINA_FALSE on failure, #EINA_TRUE otherwise. 393 * @return #EINA_FALSE on failure, #EINA_TRUE otherwise.
394 * 394 *
395 * This function adds the test named @p name to @p benchmark. @p 395 * This function adds the test named @p name to @p benchmark. @p
@@ -411,7 +411,7 @@ EAPI Eina_Bool eina_benchmark_register(Eina_Benchmark *bench,
411/** 411/**
412 * @brief Runs the benchmark's registered tests. 412 * @brief Runs the benchmark's registered tests.
413 * 413 *
414 * @param bench The benchmark. 414 * @param[in,out] bench The benchmark.
415 * @return A list of gnuplot filenames for the test results, or @c NULL 415 * @return A list of gnuplot filenames for the test results, or @c NULL
416 * on failure. 416 * on failure.
417 * 417 *
diff --git a/src/lib/eina/eina_binshare.h b/src/lib/eina/eina_binshare.h
index af9781dbf4..6caee100b1 100644
--- a/src/lib/eina/eina_binshare.h
+++ b/src/lib/eina/eina_binshare.h
@@ -76,8 +76,8 @@
76/** 76/**
77 * @brief Retrieves an instance of an object for use in a program. 77 * @brief Retrieves an instance of an object for use in a program.
78 * 78 *
79 * @param [in] obj The binary object to retrieve an instance of 79 * @param[in] obj The binary object to retrieve an instance of
80 * @param [in] olen The byte size 80 * @param[in] olen The byte size
81 * @return A pointer to an instance of the object on success, 81 * @return A pointer to an instance of the object on success,
82 * otherwise @c NULL on failure 82 * otherwise @c NULL on failure
83 * 83 *
@@ -155,7 +155,7 @@ EAPI void eina_binshare_dump(void);
155 * is just returned and its reference counter is increased. Otherwise 155 * is just returned and its reference counter is increased. Otherwise
156 * it is added to the blobs to be searched and a duplicated blob 156 * it is added to the blobs to be searched and a duplicated blob
157 * of @p obj is returned. 157 * of @p obj is returned.
158 * @param ptr The binary blob to retrieve an instance of 158 * @param[in] ptr The binary blob to retrieve an instance of
159 * @return A pointer to an instance of the string on success, 159 * @return A pointer to an instance of the string on success,
160 * otherwise @c NULL on failure 160 * otherwise @c NULL on failure
161 * 161 *
diff --git a/src/lib/eina/eina_convert.h b/src/lib/eina/eina_convert.h
index ec89804c18..026fc6c8f6 100644
--- a/src/lib/eina/eina_convert.h
+++ b/src/lib/eina/eina_convert.h
@@ -165,8 +165,8 @@ EAPI extern Eina_Error EINA_ERROR_CONVERT_OUTRUN_STRING_LENGTH; /**< Not used, p
165/** 165/**
166 * @brief Converts an integer number to a string in decimal base. 166 * @brief Converts an integer number to a string in decimal base.
167 * 167 *
168 * @param n The integer to convert. 168 * @param[in] n The integer to convert.
169 * @param s The buffer to store the converted integer. 169 * @param[out] s The buffer to store the converted integer.
170 * @return The length of the string, including the null terminated 170 * @return The length of the string, including the null terminated
171 * character. 171 * character.
172 * 172 *
@@ -182,8 +182,8 @@ EAPI int eina_convert_itoa(int n, char *s) EINA_ARG_NONNULL(2);
182/** 182/**
183 * @brief Converts an integer number to a string in hexadecimal base. 183 * @brief Converts an integer number to a string in hexadecimal base.
184 * 184 *
185 * @param n The integer to convert. 185 * @param[in] n The integer to convert.
186 * @param s The buffer to store the converted integer. 186 * @param[out] s The buffer to store the converted integer.
187 * @return The length of the string, including the null terminated 187 * @return The length of the string, including the null terminated
188 * character. 188 * character.
189 * 189 *
@@ -201,8 +201,8 @@ EAPI int eina_convert_xtoa(unsigned int n, char *s) EINA_ARG_NONNULL(2);
201/** 201/**
202 * @brief Converts a double to a string. 202 * @brief Converts a double to a string.
203 * 203 *
204 * @param d The double to convert. 204 * @param[in] d The double to convert.
205 * @param des The destination buffer to store the converted double. 205 * @param[out] des The destination buffer to store the converted double.
206 * @return #EINA_TRUE on success, #EINA_FALSE otherwise. 206 * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
207 * 207 *
208 * This function converts the double @p d to a string. The string is 208 * This function converts the double @p d to a string. The string is
@@ -225,10 +225,10 @@ EAPI int eina_convert_dtoa(double d, char *des) EINA_ARG_NONNULL(2);
225/** 225/**
226 * @brief Converts a string to a double. 226 * @brief Converts a string to a double.
227 * 227 *
228 * @param src The string to convert. 228 * @param[in] src The string to convert.
229 * @param length The length of the string. 229 * @param[in] length The length of the string.
230 * @param m The mantissa. 230 * @param[out] m The mantissa.
231 * @param e The exponent. 231 * @param[out] e The exponent.
232 * @return #EINA_TRUE on success, #EINA_FALSE otherwise. 232 * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
233 * 233 *
234 * This function converts the string @p s of length @p length that 234 * This function converts the string @p s of length @p length that
@@ -262,12 +262,11 @@ EAPI Eina_Bool eina_convert_atod(const char *src,
262 long long *m, 262 long long *m,
263 long *e) EINA_ARG_NONNULL(1, 3, 4); 263 long *e) EINA_ARG_NONNULL(1, 3, 4);
264 264
265
266/** 265/**
267 * @brief Converts a 32.32 fixed point number to a string. 266 * @brief Converts a 32.32 fixed point number to a string.
268 * 267 *
269 * @param fp The fixed point number to convert. 268 * @param[in] fp The fixed point number to convert.
270 * @param des The destination buffer to store the converted fixed point number. 269 * @param[out] des The destination buffer to store the converted fixed point number.
271 * @return #EINA_TRUE on success, #EINA_FALSE otherwise. 270 * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
272 * 271 *
273 * This function converts the 32.32 fixed point number @p fp to a 272 * This function converts the 32.32 fixed point number @p fp to a
@@ -296,9 +295,9 @@ EAPI int eina_convert_fptoa(Eina_F32p32 fp,
296/** 295/**
297 * @brief Converts a string to a 32.32 fixed point number. 296 * @brief Converts a string to a 32.32 fixed point number.
298 * 297 *
299 * @param src The string to convert. 298 * @param[in] src The string to convert.
300 * @param length The length of the string. 299 * @param[in] length The length of the string.
301 * @param fp The fixed point number. 300 * @param[out] fp The fixed point number.
302 * @return #EINA_TRUE on success, #EINA_FALSE otherwise. 301 * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
303 * 302 *
304 * This function converts the string @p src of length @p length that 303 * This function converts the string @p src of length @p length that
diff --git a/src/lib/eina/eina_quad.h b/src/lib/eina/eina_quad.h
index 2a8b058bf4..c4cdc9fc90 100644
--- a/src/lib/eina/eina_quad.h
+++ b/src/lib/eina/eina_quad.h
@@ -57,8 +57,8 @@ typedef struct _Eina_Quad
57/** 57/**
58 * @brief Transform the given quadrangle to the given rectangle. 58 * @brief Transform the given quadrangle to the given rectangle.
59 * 59 *
60 * @param q The quadrangle to get coordinates. 60 * @param[in] q The quadrangle to get coordinates.
61 * @param r The rectangle. 61 * @param[out] r The rectangle.
62 * 62 *
63 * @since 1.14 63 * @since 1.14
64 * */ 64 * */
@@ -67,8 +67,8 @@ EAPI void eina_quad_rectangle_to(const Eina_Quad *q,
67/** 67/**
68 * @brief Transform the given rectangle to the given quadrangle. 68 * @brief Transform the given rectangle to the given quadrangle.
69 * 69 *
70 * @param q The quadrangle. 70 * @param[in] q The quadrangle.
71 * @param r The rectangle to get coordinates. 71 * @param[out] r The rectangle to get coordinates.
72 * 72 *
73 * @since 1.14 73 * @since 1.14
74 * */ 74 * */
@@ -77,15 +77,15 @@ EAPI void eina_quad_rectangle_from(Eina_Quad *q,
77/** 77/**
78 * @brief Sets the values of the coordinates of the given quadrangle. 78 * @brief Sets the values of the coordinates of the given quadrangle.
79 * 79 *
80 * @param q The quadrangle to set coordinates. 80 * @param[out] q The quadrangle to set coordinates.
81 * @param x0 Top left x coordinate. 81 * @param[in] x0 Top left x coordinate.
82 * @param y0 Top left y coordinate. 82 * @param[in] y0 Top left y coordinate.
83 * @param x1 Top right x coordinate. 83 * @param[in] x1 Top right x coordinate.
84 * @param y1 Top right y coordinate. 84 * @param[in] y1 Top right y coordinate.
85 * @param x2 Bottom right x coordinate. 85 * @param[in] x2 Bottom right x coordinate.
86 * @param y2 Bottom right y coordinate. 86 * @param[in] y2 Bottom right y coordinate.
87 * @param x3 Bottom left x coordinate. 87 * @param[in] x3 Bottom left x coordinate.
88 * @param y3 Bottom left y coordinate. 88 * @param[in] y3 Bottom left y coordinate.
89 * 89 *
90 * @since 1.14 90 * @since 1.14
91 * */ 91 * */
@@ -98,15 +98,15 @@ EAPI void eina_quad_coords_set(Eina_Quad *q,
98/** 98/**
99 * @brief Gets the values of the coordinates of the given quadrangle. 99 * @brief Gets the values of the coordinates of the given quadrangle.
100 * 100 *
101 * @param q The quadrangle to get coordinates. 101 * @param[in] q The quadrangle to get coordinates.
102 * @param x0 Top left x coordinate. 102 * @param[out] x0 Top left x coordinate.
103 * @param y0 Top left y coordinate. 103 * @param[out] y0 Top left y coordinate.
104 * @param x1 Top right x coordinate. 104 * @param[out] x1 Top right x coordinate.
105 * @param y1 Top right y coordinate. 105 * @param[out] y1 Top right y coordinate.
106 * @param x2 Bottom right x coordinate. 106 * @param[out] x2 Bottom right x coordinate.
107 * @param y2 Bottom right y coordinate. 107 * @param[out] y2 Bottom right y coordinate.
108 * @param x3 Bottom left x coordinate. 108 * @param[out] x3 Bottom left x coordinate.
109 * @param y3 Bottom left y coordinate. 109 * @param[out] y3 Bottom left y coordinate.
110 * 110 *
111 * @since 1.14 111 * @since 1.14
112 * */ 112 * */