summaryrefslogtreecommitdiff
path: root/src/lib/eina
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2018-09-19 08:35:02 +0900
committerHermet Park <hermetpark@gmail.com>2018-09-19 08:35:02 +0900
commitb02257e781efc4505a6ee7df9c65156eac7e2b47 (patch)
tree79c3f13b17ec5598069e05968a651324cce61f94 /src/lib/eina
parent66bacbde9622f14e454a6d935ddda20663e1093f (diff)
eina cow: Cleanup doxygen syntax
Summary: The "be careful" advice seems a bit odd in api docs, better to just flag them with doxygen @note's. Subscribers: cedric, #reviewers, #committers Tags: #efl Differential Revision: https://phab.enlightenment.org/D7061
Diffstat (limited to 'src/lib/eina')
-rw-r--r--src/lib/eina/eina_cow.h11
1 files changed, 7 insertions, 4 deletions
diff --git a/src/lib/eina/eina_cow.h b/src/lib/eina/eina_cow.h
index db2acd5fc0..800371b1ad 100644
--- a/src/lib/eina/eina_cow.h
+++ b/src/lib/eina/eina_cow.h
@@ -95,7 +95,7 @@ EAPI void eina_cow_free(Eina_Cow *cow, const Eina_Cow_Data **data);
95 * @param[in,out] cow The pool the pointer came from. 95 * @param[in,out] cow The pool the pointer came from.
96 * @param[in] src The pointer you want to write to. 96 * @param[in] src The pointer you want to write to.
97 * 97 *
98 * NOTE: this function is not thread safe, be careful. 98 * @note This function is not thread safe.
99 */ 99 */
100EAPI void *eina_cow_write(Eina_Cow *cow, 100EAPI void *eina_cow_write(Eina_Cow *cow,
101 const Eina_Cow_Data * const *src) EINA_WARN_UNUSED_RESULT; 101 const Eina_Cow_Data * const *src) EINA_WARN_UNUSED_RESULT;
@@ -108,7 +108,7 @@ EAPI void *eina_cow_write(Eina_Cow *cow,
108 * @param[in] data The pointer to which data was written to. 108 * @param[in] data The pointer to which data was written to.
109 * @param[in] needed_gc Does this pool need to be garbage collected? 109 * @param[in] needed_gc Does this pool need to be garbage collected?
110 * 110 *
111 * NOTE: this function is not thread safe, be careful. 111 * @note This function is not thread safe.
112 */ 112 */
113EAPI void eina_cow_done(Eina_Cow *cow, 113EAPI void eina_cow_done(Eina_Cow *cow,
114 const Eina_Cow_Data * const *dst, 114 const Eina_Cow_Data * const *dst,
@@ -145,9 +145,10 @@ EAPI Eina_Bool eina_cow_gc(Eina_Cow *cow);
145 * @param[in] Read The const pointer to get a writable handler from. 145 * @param[in] Read The const pointer to get a writable handler from.
146 * @param[in] Write_Type The type of the pointer you want to write to. 146 * @param[in] Write_Type The type of the pointer you want to write to.
147 * @param[in] Write The name of the variable where to put the writeable pointer to. 147 * @param[in] Write The name of the variable where to put the writeable pointer to.
148 *
148 * @since 1.8.0 149 * @since 1.8.0
149 * 150 *
150 * Be careful: this macro opens a C scope that is expected to be closed by 151 * @note This macro opens a C scope that is expected to be closed by
151 * EINA_COW_WRITE_END(). 152 * EINA_COW_WRITE_END().
152 */ 153 */
153#define EINA_COW_WRITE_BEGIN(Cow, Read, Write_Type, Write) \ 154#define EINA_COW_WRITE_BEGIN(Cow, Read, Write_Type, Write) \
@@ -160,12 +161,14 @@ EAPI Eina_Bool eina_cow_gc(Eina_Cow *cow);
160/** 161/**
161 * @def EINA_COW_WRITE_END 162 * @def EINA_COW_WRITE_END
162 * @brief Definition for the macro to close the writeable pointer. 163 * @brief Definition for the macro to close the writeable pointer.
164 *
163 * @param[in,out] Cow The Eina_Cow where the const pointer came from. 165 * @param[in,out] Cow The Eina_Cow where the const pointer came from.
164 * @param[in] Read The const pointer to get a writable handler from. 166 * @param[in] Read The const pointer to get a writable handler from.
165 * @param[in] Write The name of the variable where to put the writeable pointer to. 167 * @param[in] Write The name of the variable where to put the writeable pointer to.
168 *
166 * @since 1.8.0 169 * @since 1.8.0
167 * 170 *
168 * Be careful: this macro close the scope opened by EINA_COW_WRITE_BEGIN(). 171 * @note This macro closes the scope opened by EINA_COW_WRITE_BEGIN().
169 */ 172 */
170#define EINA_COW_WRITE_END(Cow, Read, Write) \ 173#define EINA_COW_WRITE_END(Cow, Read, Write) \
171 eina_cow_done(Cow, ((const Eina_Cow_Data**)&(Read)), Write, \ 174 eina_cow_done(Cow, ((const Eina_Cow_Data**)&(Read)), Write, \