summaryrefslogtreecommitdiff
path: root/src/lib
diff options
context:
space:
mode:
authorJinYong Park <j4939.park@samsung.com>2017-10-27 11:33:50 -0700
committerCedric Bail <cedric@osg.samsung.com>2017-10-27 12:12:25 -0700
commitb550581dde0082176e3652a0f5c0174610611785 (patch)
treefed458f09b033233a4d9bb3d18e69c6acb474b80 /src/lib
parent162d1b0577096323666604d02268aa842ee9ff11 (diff)
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 <cedric@osg.samsung.com>
Diffstat (limited to 'src/lib')
-rw-r--r--src/lib/eina/eina_unicode.h21
1 files changed, 21 insertions, 0 deletions
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
56 56
57/** 57/**
58 * @brief Same as the standard strdup just with Eina_Unicode instead of char. 58 * @brief Same as the standard strdup just with Eina_Unicode instead of char.
59 *
60 * @param text The text to duplicate.
61 * @return The duplicated string.
59 */ 62 */
60EAPI Eina_Unicode *eina_unicode_strdup(const Eina_Unicode *text) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC; 63EAPI Eina_Unicode *eina_unicode_strdup(const Eina_Unicode *text) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC;
61 64
@@ -78,24 +81,42 @@ EAPI Eina_Unicode *eina_unicode_strndup(const Eina_Unicode *text, size_t n) EINA
78 81
79/** 82/**
80 * @brief Same as the standard strcmp just with Eina_Unicode instead of char. 83 * @brief Same as the standard strcmp just with Eina_Unicode instead of char.
84 *
85 * @param a The text to be compared.
86 * @param b The text to be compared.
87 * @return An integer value indicating the ordinal relation of @p a to @p b.
81 */ 88 */
82EAPI int eina_unicode_strcmp(const Eina_Unicode *a, const Eina_Unicode *b) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2) EINA_PURE; 89EAPI int eina_unicode_strcmp(const Eina_Unicode *a, const Eina_Unicode *b) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2) EINA_PURE;
83 90
84 91
85/** 92/**
86 * @brief Same as the standard strcpy just with Eina_Unicode instead of char. 93 * @brief Same as the standard strcpy just with Eina_Unicode instead of char.
94 *
95 * @param dest The text which @p source is to be copied.
96 * @param source The text to copy from.
97 * @return @p dest is returned.
87 */ 98 */
88EAPI Eina_Unicode *eina_unicode_strcpy(Eina_Unicode *dest, const Eina_Unicode *source) EINA_ARG_NONNULL(1, 2); 99EAPI Eina_Unicode *eina_unicode_strcpy(Eina_Unicode *dest, const Eina_Unicode *source) EINA_ARG_NONNULL(1, 2);
89 100
90 101
91/** 102/**
92 * @brief Same as the standard strstr just with Eina_Unicode instead of char. 103 * @brief Same as the standard strstr just with Eina_Unicode instead of char.
104 *
105 * @param haystack The text to be searched.
106 * @param needle The text to search for
107 * @return The substring of @p haystack which starts with @p needle
108 * when @p needle is founded in @p haystack, or NULL is returned.
93 */ 109 */
94EAPI Eina_Unicode *eina_unicode_strstr(const Eina_Unicode *haystack, const Eina_Unicode *needle) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2) EINA_PURE; 110EAPI Eina_Unicode *eina_unicode_strstr(const Eina_Unicode *haystack, const Eina_Unicode *needle) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2) EINA_PURE;
95 111
96 112
97/** 113/**
98 * @brief Same as the standard strncpy just with Eina_Unicode instead of char. 114 * @brief Same as the standard strncpy just with Eina_Unicode instead of char.
115 *
116 * @param dest The text which @p source is to be copied.
117 * @param source The text to copy from.
118 * @param n Maximum number of characters to be copied from @p source.
119 * @return @p dest is returned.
99 */ 120 */
100EAPI Eina_Unicode *eina_unicode_strncpy(Eina_Unicode *dest, const Eina_Unicode *source, size_t n) EINA_ARG_NONNULL(1, 2); 121EAPI Eina_Unicode *eina_unicode_strncpy(Eina_Unicode *dest, const Eina_Unicode *source, size_t n) EINA_ARG_NONNULL(1, 2);
101 122