enlightenment/efl
enlightenment
/
efl
8
7
Fork 14
Code Issues 13 Pull Requests 3 Projects Releases Wiki Activity

eina: Add doxygen in/out tags 

Reviewers: Hermet

Reviewed By: Hermet

Subscribers: cedric, #committers, zmike

Tags: #efl

Differential Revision: https://phab.enlightenment.org/D6624
This commit is contained in:
Bryce Harrington 2018-07-18 15:21:07 +09:00 committed by Hermet Park
parent 268d3fcef5
commit 096c01a818
5 changed files with 53 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/lib/eina/eina_alloca.h
View File

@ -42,11 +42,12 @@
# ifdef __cplusplus
extern "C"
# endif
/**
* @brief Allocates memory in the stack frame of the caller, so that it
* is automatically freed when the caller returns.
*
* @param size Number of bytes of space to allocate.
* @param[in] size Number of bytes of space to allocate.
* @return Pointer to beginning of the allocated space.
*
* @see alloca(3) for more details.

22
src/lib/eina/eina_benchmark.h
View File

@ -346,7 +346,7 @@ typedef void (*Eina_Benchmark_Specimens)(int request);
* @def EINA_BENCHMARK
* @brief Definition for the cast to an #Eina_Benchmark_Specimens.
*
* @param function The function to cast.
* @param[in] function The function to cast.
*
* This macro casts @p function to Eina_Benchmark_Specimens.
*/
@ -356,8 +356,8 @@ typedef void (*Eina_Benchmark_Specimens)(int request);
/**
* @brief Creates a new array.
*
* @param name The name of the benchmark.
* @param run The name of the run.
* @param[in] name The name of the benchmark.
* @param[in] run The name of the run.
* @return A valid benchmark on success, or @c NULL on memory allocation
* failure.
*
@ -373,7 +373,7 @@ EAPI Eina_Benchmark *eina_benchmark_new(const char *name,
/**
* @brief Frees a benchmark object.
*
* @param bench The benchmark to free.
* @param[in,out] bench The benchmark to free.
*
* This function removes all the benchmark tests that have been
* registered and frees @p bench. If @p bench is @c NULL, this
@ -384,12 +384,12 @@ EAPI void eina_benchmark_free(Eina_Benchmark *bench);
/**
* @brief Adds a test to a benchmark.
*
* @param bench The benchmark.
* @param name The name of the test.
* @param bench_cb The test function to be called.
* @param count_start The start data to be passed to @p bench_cb.
* @param count_end The end data to be passed to @p bench_cb.
* @param count_step The step data to be passed to @p bench_cb.
* @param[in,out] bench The benchmark.
* @param[in] name The name of the test.
* @param[in] bench_cb The test function to be called.
* @param[in] count_start The start data to be passed to @p bench_cb.
* @param[in] count_end The end data to be passed to @p bench_cb.
* @param[in] count_step The step data to be passed to @p bench_cb.
* @return #EINA_FALSE on failure, #EINA_TRUE otherwise.
*
* 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,
/**
* @brief Runs the benchmark's registered tests.
*
* @param bench The benchmark.
* @param[in,out] bench The benchmark.
* @return A list of gnuplot filenames for the test results, or @c NULL
* on failure.
*

6
src/lib/eina/eina_binshare.h
View File

@ -76,8 +76,8 @@
/**
* @brief Retrieves an instance of an object for use in a program.
*
* @param [in] obj The binary object to retrieve an instance of
* @param [in] olen The byte size
* @param[in] obj The binary object to retrieve an instance of
* @param[in] olen The byte size
* @return A pointer to an instance of the object on success,
* otherwise @c NULL on failure
*
@ -155,7 +155,7 @@ EAPI void eina_binshare_dump(void);
* is just returned and its reference counter is increased. Otherwise
* it is added to the blobs to be searched and a duplicated blob
* of @p obj is returned.
* @param ptr The binary blob to retrieve an instance of
* @param[in] ptr The binary blob to retrieve an instance of
* @return A pointer to an instance of the string on success,
* otherwise @c NULL on failure
*

31
src/lib/eina/eina_convert.h
View File

@ -165,8 +165,8 @@ EAPI extern Eina_Error EINA_ERROR_CONVERT_OUTRUN_STRING_LENGTH; /**< Not used, p
/**
* @brief Converts an integer number to a string in decimal base.
*
* @param n The integer to convert.
* @param s The buffer to store the converted integer.
* @param[in] n The integer to convert.
* @param[out] s The buffer to store the converted integer.
* @return The length of the string, including the null terminated
* character.
*
@ -182,8 +182,8 @@ EAPI int eina_convert_itoa(int n, char *s) EINA_ARG_NONNULL(2);
/**
* @brief Converts an integer number to a string in hexadecimal base.
*
* @param n The integer to convert.
* @param s The buffer to store the converted integer.
* @param[in] n The integer to convert.
* @param[out] s The buffer to store the converted integer.
* @return The length of the string, including the null terminated
* character.
*
@ -201,8 +201,8 @@ EAPI int eina_convert_xtoa(unsigned int n, char *s) EINA_ARG_NONNULL(2);
/**
* @brief Converts a double to a string.
*
* @param d The double to convert.
* @param des The destination buffer to store the converted double.
* @param[in] d The double to convert.
* @param[out] des The destination buffer to store the converted double.
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* 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);
/**
* @brief Converts a string to a double.
*
* @param src The string to convert.
* @param length The length of the string.
* @param m The mantissa.
* @param e The exponent.
* @param[in] src The string to convert.
* @param[in] length The length of the string.
* @param[out] m The mantissa.
* @param[out] e The exponent.
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* 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,
long long *m,
long *e) EINA_ARG_NONNULL(1, 3, 4);
/**
* @brief Converts a 32.32 fixed point number to a string.
*
* @param fp The fixed point number to convert.
* @param des The destination buffer to store the converted fixed point number.
* @param[in] fp The fixed point number to convert.
* @param[out] des The destination buffer to store the converted fixed point number.
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* 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,
/**
* @brief Converts a string to a 32.32 fixed point number.
*
* @param src The string to convert.
* @param length The length of the string.
* @param fp The fixed point number.
* @param[in] src The string to convert.
* @param[in] length The length of the string.
* @param[out] fp The fixed point number.
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
*
* This function converts the string @p src of length @p length that

44
src/lib/eina/eina_quad.h
View File

@ -57,8 +57,8 @@ typedef struct _Eina_Quad
/**
* @brief Transform the given quadrangle to the given rectangle.
*
* @param q The quadrangle to get coordinates.
* @param r The rectangle.
* @param[in] q The quadrangle to get coordinates.
* @param[out] r The rectangle.
*
* @since 1.14
* */
@ -67,8 +67,8 @@ EAPI void eina_quad_rectangle_to(const Eina_Quad *q,
/**
* @brief Transform the given rectangle to the given quadrangle.
*
* @param q The quadrangle.
* @param r The rectangle to get coordinates.
* @param[in] q The quadrangle.
* @param[out] r The rectangle to get coordinates.
*
* @since 1.14
* */
@ -77,15 +77,15 @@ EAPI void eina_quad_rectangle_from(Eina_Quad *q,
/**
* @brief Sets the values of the coordinates of the given quadrangle.
*
* @param q The quadrangle to set coordinates.
* @param x0 Top left x coordinate.
* @param y0 Top left y coordinate.
* @param x1 Top right x coordinate.
* @param y1 Top right y coordinate.
* @param x2 Bottom right x coordinate.
* @param y2 Bottom right y coordinate.
* @param x3 Bottom left x coordinate.
* @param y3 Bottom left y coordinate.
* @param[out] q The quadrangle to set coordinates.
* @param[in] x0 Top left x coordinate.
* @param[in] y0 Top left y coordinate.
* @param[in] x1 Top right x coordinate.
* @param[in] y1 Top right y coordinate.
* @param[in] x2 Bottom right x coordinate.
* @param[in] y2 Bottom right y coordinate.
* @param[in] x3 Bottom left x coordinate.
* @param[in] y3 Bottom left y coordinate.
*
* @since 1.14
* */
@ -98,15 +98,15 @@ EAPI void eina_quad_coords_set(Eina_Quad *q,
/**
* @brief Gets the values of the coordinates of the given quadrangle.
*
* @param q The quadrangle to get coordinates.
* @param x0 Top left x coordinate.
* @param y0 Top left y coordinate.
* @param x1 Top right x coordinate.
* @param y1 Top right y coordinate.
* @param x2 Bottom right x coordinate.
* @param y2 Bottom right y coordinate.
* @param x3 Bottom left x coordinate.
* @param y3 Bottom left y coordinate.
* @param[in] q The quadrangle to get coordinates.
* @param[out] x0 Top left x coordinate.
* @param[out] y0 Top left y coordinate.
* @param[out] x1 Top right x coordinate.
* @param[out] y1 Top right y coordinate.
* @param[out] x2 Bottom right x coordinate.
* @param[out] y2 Bottom right y coordinate.
* @param[out] x3 Bottom left x coordinate.
* @param[out] y3 Bottom left y coordinate.
*
* @since 1.14
* */