cedric pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=b550581dde0082176e3652a0f5c0174610611785
commit b550581dde0082176e3652a0f5c0174610611785
Author: JinYong Park <j4939.p...@samsung.com>
Date: Fri Oct 27 11:33:50 2017 -0700
eina: add param, return type description for eina_unicode.
Summary: Add missing parameters and return type description to remove
doxygen warning
Test Plan: API Doxygen Revision
Reviewers: cedric, jpeg, myoungwoon, Jaehyun_Cho, id213sin
Differential Revision: https://phab.enlightenment.org/D5396
Signed-off-by: Cedric Bail <ced...@osg.samsung.com>
---
src/lib/eina/eina_unicode.h | 21 +++++++++++++++++++++
1 file changed, 21 insertions(+)
diff --git a/src/lib/eina/eina_unicode.h b/src/lib/eina/eina_unicode.h
index 3d37dee332..d9b961bd4d 100644
--- a/src/lib/eina/eina_unicode.h
+++ b/src/lib/eina/eina_unicode.h
@@ -56,6 +56,9 @@ EAPI size_t eina_unicode_strnlen(const Eina_Unicode
*ustr, int n) EINA_AR
/**
* @brief Same as the standard strdup just with Eina_Unicode instead of char.
+ *
+ * @param text The text to duplicate.
+ * @return The duplicated string.
*/
EAPI Eina_Unicode *eina_unicode_strdup(const Eina_Unicode *text)
EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC;
@@ -78,24 +81,42 @@ EAPI Eina_Unicode *eina_unicode_strndup(const Eina_Unicode
*text, size_t n) EINA
/**
* @brief Same as the standard strcmp just with Eina_Unicode instead of char.
+ *
+ * @param a The text to be compared.
+ * @param b The text to be compared.
+ * @return An integer value indicating the ordinal relation of @p a to @p b.
*/
EAPI int eina_unicode_strcmp(const Eina_Unicode *a, const
Eina_Unicode *b) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2) EINA_PURE;
/**
* @brief Same as the standard strcpy just with Eina_Unicode instead of char.
+ *
+ * @param dest The text which @p source is to be copied.
+ * @param source The text to copy from.
+ * @return @p dest is returned.
*/
EAPI Eina_Unicode *eina_unicode_strcpy(Eina_Unicode *dest, const Eina_Unicode
*source) EINA_ARG_NONNULL(1, 2);
/**
* @brief Same as the standard strstr just with Eina_Unicode instead of char.
+ *
+ * @param haystack The text to be searched.
+ * @param needle The text to search for
+ * @return The substring of @p haystack which starts with @p needle
+ * when @p needle is founded in @p haystack, or NULL is returned.
*/
EAPI Eina_Unicode *eina_unicode_strstr(const Eina_Unicode *haystack, const
Eina_Unicode *needle) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2) EINA_PURE;
/**
* @brief Same as the standard strncpy just with Eina_Unicode instead of char.
+ *
+ * @param dest The text which @p source is to be copied.
+ * @param source The text to copy from.
+ * @param n Maximum number of characters to be copied from @p source.
+ * @return @p dest is returned.
*/
EAPI Eina_Unicode *eina_unicode_strncpy(Eina_Unicode *dest, const Eina_Unicode
*source, size_t n) EINA_ARG_NONNULL(1, 2);
--
