summaryrefslogtreecommitdiff
path: root/src/lib/eina
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2018-07-12 16:13:57 +0900
committerHermet Park <hermetpark@gmail.com>2018-07-12 16:14:42 +0900
commit6a68e51460b51554e68c79d1c97325b4dd97eb83 (patch)
tree6644f8e9c0c0fb2d4916675587b6fcf9a977a67d /src/lib/eina
parent4951c8b1e6a865f129d8ffc3c382d2d9560b150d (diff)
eina: Add doxygen in/out tags for binbuf's parameters
Reviewers: devilhorns, Hermet Reviewed By: Hermet Subscribers: cedric, #committers, zmike Tags: #efl Differential Revision: https://phab.enlightenment.org/D6571
Diffstat (limited to 'src/lib/eina')
-rw-r--r--src/lib/eina/eina_binbuf.h84
1 files changed, 42 insertions, 42 deletions
diff --git a/src/lib/eina/eina_binbuf.h b/src/lib/eina/eina_binbuf.h
index f9e688d5e0..6b1ed48ffe 100644
--- a/src/lib/eina/eina_binbuf.h
+++ b/src/lib/eina/eina_binbuf.h
@@ -52,9 +52,9 @@ EAPI Eina_Binbuf *eina_binbuf_new(void) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
52/** 52/**
53 * @brief Creates a new string buffer using the passed string. 53 * @brief Creates a new string buffer using the passed string.
54 * 54 *
55 * @param str The string to manage. 55 * @param[in] str The string to manage.
56 * @param length The length of the string. 56 * @param[in] length The length of the string.
57 * @param ro The passed string will not be touched if set to #EINA_TRUE. 57 * @param[in] ro The passed string will not be touched if set to #EINA_TRUE.
58 * @return Newly allocated string buffer instance, or @c NULL on error. 58 * @return Newly allocated string buffer instance, or @c NULL on error.
59 * 59 *
60 * This function creates a new binary string buffer. The passed string 60 * This function creates a new binary string buffer. The passed string
@@ -78,8 +78,8 @@ EAPI Eina_Binbuf *eina_binbuf_manage_new(const unsigned char *str, size_t length
78/** 78/**
79 * @brief Creates a new string buffer using the passed string. 79 * @brief Creates a new string buffer using the passed string.
80 * 80 *
81 * @param str The string to manage. 81 * @param[in] str The string to manage.
82 * @param length The length of the string. 82 * @param[in] length The length of the string.
83 * @return Newly allocated string buffer instance, or @c NULL on error. 83 * @return Newly allocated string buffer instance, or @c NULL on error.
84 * 84 *
85 * This function creates a new string buffer. To free the resources, use 85 * This function creates a new string buffer. To free the resources, use
@@ -94,8 +94,8 @@ EAPI Eina_Binbuf *eina_binbuf_manage_new_length(unsigned char *str, size_t lengt
94/** 94/**
95 * @brief Creates a new string buffer using the passed string. 95 * @brief Creates a new string buffer using the passed string.
96 * 96 *
97 * @param str The string to start from. 97 * @param[in] str The string to start from.
98 * @param length The length of the string. 98 * @param[in] length The length of the string.
99 * @return Newly allocated string buffer instance, or @c NULL on error. 99 * @return Newly allocated string buffer instance, or @c NULL on error.
100 * 100 *
101 * This function creates a new string buffer. The passed string is used 101 * This function creates a new string buffer. The passed string is used
@@ -114,7 +114,7 @@ EAPI Eina_Binbuf *eina_binbuf_manage_read_only_new_length(const unsigned char *s
114/** 114/**
115 * @brief Frees a string buffer. 115 * @brief Frees a string buffer.
116 * 116 *
117 * @param buf The string buffer to free. 117 * @param[in,out] buf The string buffer.
118 * 118 *
119 * This function frees the memory of @p buf. @p buf must have been 119 * This function frees the memory of @p buf. @p buf must have been
120 * created by eina_binbuf_new(). 120 * created by eina_binbuf_new().
@@ -124,7 +124,7 @@ EAPI void eina_binbuf_free(Eina_Binbuf *buf) EINA_ARG_NONNULL(1);
124/** 124/**
125 * @brief Resets a string buffer. 125 * @brief Resets a string buffer.
126 * 126 *
127 * @param buf The string buffer. 127 * @param[in,out] buf The string buffer.
128 * 128 *
129 * This function resets @p buf: the buffer len is set to 0, and the 129 * This function resets @p buf: the buffer len is set to 0, and the
130 * string is set to '\\0'. No memory is freed. 130 * string is set to '\\0'. No memory is freed.
@@ -134,8 +134,8 @@ EAPI void eina_binbuf_reset(Eina_Binbuf *buf) EINA_ARG_NONNULL(1);
134/** 134/**
135 * @brief Expands a buffer, making room for at least @p minimum_unused_space. 135 * @brief Expands a buffer, making room for at least @p minimum_unused_space.
136 * 136 *
137 * @param buf The Buffer to expand. 137 * @param[in,out] buf The Buffer to expand.
138 * @param minimum_unused_space The minimum unused allocated space, in 138 * @param[in] minimum_unused_space The minimum unused allocated space, in
139 * bytes, at the end of the buffer. Zero can be used to query 139 * bytes, at the end of the buffer. Zero can be used to query
140 * the available slice of unused bytes. 140 * the available slice of unused bytes.
141 * @return The slice of unused bytes. The slice length may be zero if 141 * @return The slice of unused bytes. The slice length may be zero if
@@ -164,8 +164,8 @@ EAPI Eina_Rw_Slice eina_binbuf_expand(Eina_Binbuf *buf, size_t minimum_unused_sp
164/** 164/**
165 * @brief Marks more bytes as used. 165 * @brief Marks more bytes as used.
166 * 166 *
167 * @param buf The buffer to mark extra bytes as used. 167 * @param[in,out] buf The string buffer.
168 * @param extra_bytes the number of bytes to be considered used, must 168 * @param[in] extra_bytes the number of bytes to be considered used, must
169 * be between zero and the length of the slice returned by 169 * be between zero and the length of the slice returned by
170 * eina_binbuf_expand(). 170 * eina_binbuf_expand().
171 * @return #EINA_TRUE on success, #EINA_FALSE on failure, such as 171 * @return #EINA_TRUE on success, #EINA_FALSE on failure, such as
@@ -185,9 +185,9 @@ EAPI Eina_Bool eina_binbuf_use(Eina_Binbuf *buf, size_t extra_bytes) EINA_ARG_NO
185 * @brief Appends a string of exact length to a buffer, reallocating as 185 * @brief Appends a string of exact length to a buffer, reallocating as
186 * necessary. 186 * necessary.
187 * 187 *
188 * @param buf The string buffer. 188 * @param[in,out] buf The string buffer.
189 * @param str The string to append. 189 * @param[in] str The string to append.
190 * @param length The exact length to use. 190 * @param[in] length The exact length to use.
191 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be appended. 191 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be appended.
192 * 192 *
193 * This function appends @p str to @p buf. @p str must be of size at 193 * This function appends @p str to @p buf. @p str must be of size at
@@ -204,8 +204,8 @@ EAPI Eina_Bool eina_binbuf_append_length(Eina_Binbuf *buf, const unsigned char *
204/** 204/**
205 * @brief Appends a slice to a buffer, reallocating as necessary. 205 * @brief Appends a slice to a buffer, reallocating as necessary.
206 * 206 *
207 * @param buf The string buffer. 207 * @param[in,out] buf The string buffer.
208 * @param slice The slice to append. 208 * @param[in] slice The slice to append.
209 * @return #EINA_TRUE on success, #EINA_FALSE if @p slice could not be appended. 209 * @return #EINA_TRUE on success, #EINA_FALSE if @p slice could not be appended.
210 * 210 *
211 * This function appends @p slice to @p buf. 211 * This function appends @p slice to @p buf.
@@ -217,8 +217,8 @@ EAPI Eina_Bool eina_binbuf_append_slice(Eina_Binbuf *buf, const Eina_Slice slice
217/** 217/**
218 * @brief Appends an Eina_Binbuf to a buffer, reallocating as necessary. 218 * @brief Appends an Eina_Binbuf to a buffer, reallocating as necessary.
219 * 219 *
220 * @param buf The string buffer. 220 * @param[in,out] buf The string buffer.
221 * @param data The string buffer to append. 221 * @param[in] data The string buffer to append.
222 * @return #EINA_TRUE on success, #EINA_FALSE if @p data could not be appended. 222 * @return #EINA_TRUE on success, #EINA_FALSE if @p data could not be appended.
223 * 223 *
224 * This function appends @p data to @p buf. @p data must be allocated and 224 * This function appends @p data to @p buf. @p data must be allocated and
@@ -237,8 +237,8 @@ EAPI Eina_Bool eina_binbuf_append_buffer(Eina_Binbuf *buf, const Eina_Binbuf *da
237 * @brief Appends a character to a string buffer, reallocating as 237 * @brief Appends a character to a string buffer, reallocating as
238 * necessary. 238 * necessary.
239 * 239 *
240 * @param buf The string buffer. 240 * @param[in,out] buf The string buffer.
241 * @param c The char to append. 241 * @param[in] c The char to append.
242 * @return #EINA_TRUE on success, #EINA_FALSE if @p c could not be inserted. 242 * @return #EINA_TRUE on success, #EINA_FALSE if @p c could not be inserted.
243 * 243 *
244 * This function appends @p c to @p buf. 244 * This function appends @p c to @p buf.
@@ -248,10 +248,10 @@ EAPI Eina_Bool eina_binbuf_append_char(Eina_Binbuf *buf, unsigned char c) EINA_A
248/** 248/**
249 * @brief Inserts a string of exact length into a buffer, reallocating as necessary. 249 * @brief Inserts a string of exact length into a buffer, reallocating as necessary.
250 * 250 *
251 * @param buf The string buffer. 251 * @param[in,out] buf The string buffer.
252 * @param str The string to insert. 252 * @param[in] str The string to insert.
253 * @param length The exact length to use. 253 * @param[in] length The exact length to use.
254 * @param pos The position to insert the string. 254 * @param[in] pos The position to insert the string.
255 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be inserted. 255 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be inserted.
256 * 256 *
257 * This function inserts @p str into @p buf. @p str must be no longer 257 * This function inserts @p str into @p buf. @p str must be no longer
@@ -268,9 +268,9 @@ EAPI Eina_Bool eina_binbuf_insert_length(Eina_Binbuf *buf, const unsigned char *
268/** 268/**
269 * @brief Inserts a slice into a buffer, reallocating as necessary. 269 * @brief Inserts a slice into a buffer, reallocating as necessary.
270 * 270 *
271 * @param buf The string buffer. 271 * @param[in,out] buf The string buffer.
272 * @param slice The slice to insert. 272 * @param[in] slice The slice to insert.
273 * @param pos The position to insert the string. 273 * @param[in] pos The position to insert the string.
274 * @return #EINA_TRUE on success, #EINA_FALSE if @p slice could not be inserted. 274 * @return #EINA_TRUE on success, #EINA_FALSE if @p slice could not be inserted.
275 * 275 *
276 * This function inserts @p slice into @p buf at position @p pos. 276 * This function inserts @p slice into @p buf at position @p pos.
@@ -283,9 +283,9 @@ EAPI Eina_Bool eina_binbuf_insert_slice(Eina_Binbuf *buf, const Eina_Slice slice
283 * @brief Inserts a character into a string buffer, reallocating as 283 * @brief Inserts a character into a string buffer, reallocating as
284 * necessary. 284 * necessary.
285 * 285 *
286 * @param buf The string buffer. 286 * @param[in,out] buf The string buffer.
287 * @param c The char to insert. 287 * @param[in] c The char to insert.
288 * @param pos The position to insert the char. 288 * @param[in] pos The position to insert the char.
289 * @return #EINA_TRUE on success, #EINA_FALSE if @p c could not be inserted. 289 * @return #EINA_TRUE on success, #EINA_FALSE if @p c could not be inserted.
290 * 290 *
291 * This function inserts @p c to @p buf at position @p pos. 291 * This function inserts @p c to @p buf at position @p pos.
@@ -295,10 +295,10 @@ EAPI Eina_Bool eina_binbuf_insert_char(Eina_Binbuf *buf, unsigned char c, size_t
295/** 295/**
296 * @brief Removes a slice of the given string buffer. 296 * @brief Removes a slice of the given string buffer.
297 * 297 *
298 * @param buf The string buffer. 298 * @param[in,out] buf The string buffer.
299 * @param start The initial (inclusive) slice position to start 299 * @param[in] start The initial (inclusive) slice position to start
300 * removing, in bytes. 300 * removing, in bytes.
301 * @param end The final (non-inclusive) slice position to finish 301 * @param[in] end The final (non-inclusive) slice position to finish
302 * removing, in bytes. 302 * removing, in bytes.
303 * @return #EINA_TRUE on success, #EINA_FALSE on failure. 303 * @return #EINA_TRUE on success, #EINA_FALSE on failure.
304 * 304 *
@@ -311,7 +311,7 @@ EAPI Eina_Bool eina_binbuf_remove(Eina_Binbuf *buf, size_t start, size_t end) EI
311/** 311/**
312 * @brief Retrieves a pointer to the contents of a string buffer. 312 * @brief Retrieves a pointer to the contents of a string buffer.
313 * 313 *
314 * @param buf The string buffer. 314 * @param[in] buf The string buffer.
315 * @return The string that is contained in @p buf. 315 * @return The string that is contained in @p buf.
316 * 316 *
317 * This function returns the string contained in @p buf. The returned 317 * This function returns the string contained in @p buf. The returned
@@ -326,7 +326,7 @@ EAPI const unsigned char *eina_binbuf_string_get(const Eina_Binbuf *buf) EINA_AR
326/** 326/**
327 * @brief Steals the contents of a string buffer. 327 * @brief Steals the contents of a string buffer.
328 * 328 *
329 * @param buf The string buffer. 329 * @param[in,out] buf The string buffer.
330 * @return The string that was contained in @p buf. 330 * @return The string that was contained in @p buf.
331 * 331 *
332 * This function returns the string contained in @p buf. @p buf is 332 * This function returns the string contained in @p buf. @p buf is
@@ -341,7 +341,7 @@ EAPI unsigned char *eina_binbuf_string_steal(Eina_Binbuf *buf) EINA_MALLOC EINA_
341/** 341/**
342 * @brief Frees the contents of a string buffer but not the buffer. 342 * @brief Frees the contents of a string buffer but not the buffer.
343 * 343 *
344 * @param buf The string buffer. 344 * @param[in,out] buf The string buffer.
345 * 345 *
346 * This function frees the string contained in @p buf without freeing 346 * This function frees the string contained in @p buf without freeing
347 * @p buf. 347 * @p buf.
@@ -351,7 +351,7 @@ EAPI void eina_binbuf_string_free(Eina_Binbuf *buf) EINA_ARG_NONNULL(1);
351/** 351/**
352 * @brief Retrieves the length of the string buffer's content. 352 * @brief Retrieves the length of the string buffer's content.
353 * 353 *
354 * @param buf The string buffer. 354 * @param[in] buf The string buffer.
355 * @return The current length of the string, in bytes. 355 * @return The current length of the string, in bytes.
356 * 356 *
357 * This function returns the length of @p buf. 357 * This function returns the length of @p buf.
@@ -361,7 +361,7 @@ EAPI size_t eina_binbuf_length_get(const Eina_Binbuf *buf) EINA_ARG_NONNULL(1) E
361/** 361/**
362 * @brief Gets a read-only slice of the buffer contents. 362 * @brief Gets a read-only slice of the buffer contents.
363 * 363 *
364 * @param buf The string buffer. 364 * @param[in] buf The string buffer.
365 * @return A read-only slice of the current contents. It may become 365 * @return A read-only slice of the current contents. It may become
366 * invalid as soon as @p buf is changed. 366 * invalid as soon as @p buf is changed.
367 * 367 *
@@ -372,7 +372,7 @@ EAPI Eina_Slice eina_binbuf_slice_get(const Eina_Binbuf *buf) EINA_WARN_UNUSED_R
372/** 372/**
373 * @brief Gets a read-write slice of the buffer contents. 373 * @brief Gets a read-write slice of the buffer contents.
374 * 374 *
375 * @param buf The string buffer. 375 * @param[in,out] buf The string buffer.
376 * @return A read-write slice for the current contents. It may become 376 * @return A read-write slice for the current contents. It may become
377 * invalid as soon as @p buf is changed, such as through calls like 377 * invalid as soon as @p buf is changed, such as through calls like
378 * eina_binbuf_append() or eina_binbuf_remove(). 378 * eina_binbuf_append() or eina_binbuf_remove().
@@ -386,7 +386,7 @@ EAPI Eina_Rw_Slice eina_binbuf_rw_slice_get(const Eina_Binbuf *buf) EINA_WARN_UN
386/** 386/**
387 * @brief Frees the buffer, returning its old contents. 387 * @brief Frees the buffer, returning its old contents.
388 * 388 *
389 * @param buf The string buffer. 389 * @param[in,out] buf The string buffer.
390 * @return The content contained by buf. The caller must release the 390 * @return The content contained by buf. The caller must release the
391 * memory of the returned string by calling free(). 391 * memory of the returned string by calling free().
392 * 392 *