summaryrefslogtreecommitdiff
path: root/src/lib/eina
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2018-07-13 18:23:27 +0900
committerHermet Park <hermetpark@gmail.com>2018-07-13 18:23:27 +0900
commit45173fa375e81b097c084f91c2c438c73933878f (patch)
tree031c070fbcb8db2970880a89445186919e7f9d6f /src/lib/eina
parente9925e609f3648736107e0545fb68cc45012421f (diff)
eina: Add doxygen in/out tags for strbuf's and ustrbuf's parameters
Reviewers: devilhorns, Hermet Reviewed By: Hermet Subscribers: cedric, #committers, zmike Tags: #efl Differential Revision: https://phab.enlightenment.org/D6586
Diffstat (limited to 'src/lib/eina')
-rw-r--r--src/lib/eina/eina_strbuf.h224
-rw-r--r--src/lib/eina/eina_ustrbuf.h122
2 files changed, 173 insertions, 173 deletions
diff --git a/src/lib/eina/eina_strbuf.h b/src/lib/eina/eina_strbuf.h
index 539326ad29..73d166433d 100644
--- a/src/lib/eina/eina_strbuf.h
+++ b/src/lib/eina/eina_strbuf.h
@@ -84,7 +84,7 @@ EAPI Eina_Strbuf *eina_strbuf_new(void) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
84/** 84/**
85 * @brief Creates a new string buffer using the passed string. 85 * @brief Creates a new string buffer using the passed string.
86 * 86 *
87 * @param str The string to manage. 87 * @param[in] str The string to manage.
88 * @return Newly allocated string buffer instance, or @c NULL on error. 88 * @return Newly allocated string buffer instance, or @c NULL on error.
89 * 89 *
90 * This function creates a new string buffer. The passed string is used 90 * This function creates a new string buffer. The passed string is used
@@ -103,8 +103,8 @@ EAPI Eina_Strbuf *eina_strbuf_manage_new(char *str) EINA_MALLOC EINA_WARN_UNUSED
103/** 103/**
104 * @brief Creates a new string buffer using the passed string. 104 * @brief Creates a new string buffer using the passed string.
105 * 105 *
106 * @param str The string to manage. 106 * @param[in] str The string to manage.
107 * @param length The length of the string. 107 * @param[in] length The length of the string.
108 * @return Newly allocated string buffer instance, or @c NULL on error. 108 * @return Newly allocated string buffer instance, or @c NULL on error.
109 * 109 *
110 * This function creates a new string buffer. The passed string is used 110 * This function creates a new string buffer. The passed string is used
@@ -121,8 +121,8 @@ EAPI Eina_Strbuf *eina_strbuf_manage_new_length(char *str, size_t length) EINA_M
121/** 121/**
122 * @brief Creates a new string buffer using the passed string. 122 * @brief Creates a new string buffer using the passed string.
123 * 123 *
124 * @param str The string to manage. 124 * @param[in] str The string to manage.
125 * @param length The length of the string. 125 * @param[in] length The length of the string.
126 * @return Newly allocated string buffer instance, or @c NULL on error. 126 * @return Newly allocated string buffer instance, or @c NULL on error.
127 * 127 *
128 * This function creates a new string buffer. The passed string is used 128 * This function creates a new string buffer. The passed string is used
@@ -142,7 +142,7 @@ EAPI Eina_Strbuf *eina_strbuf_manage_read_only_new_length(const char *str, size_
142/** 142/**
143 * @brief Frees a string buffer. 143 * @brief Frees a string buffer.
144 * 144 *
145 * @param buf The string buffer to free. 145 * @param[in,out] buf The string buffer to free.
146 * 146 *
147 * This function frees the memory of @p buf. @p buf must have been 147 * This function frees the memory of @p buf. @p buf must have been
148 * created by eina_strbuf_new(). 148 * created by eina_strbuf_new().
@@ -152,7 +152,7 @@ EAPI void eina_strbuf_free(Eina_Strbuf *buf) EINA_ARG_NONNULL(1);
152/** 152/**
153 * @brief Resets a string buffer. 153 * @brief Resets a string buffer.
154 * 154 *
155 * @param buf The string buffer. 155 * @param[in,out] buf The string buffer.
156 * 156 *
157 * This function resets @p buf: the buffer len is set to 0, and the 157 * This function resets @p buf: the buffer len is set to 0, and the
158 * string data is set to '\\0'. No memory is freed. 158 * string data is set to '\\0'. No memory is freed.
@@ -162,8 +162,8 @@ EAPI void eina_strbuf_reset(Eina_Strbuf *buf) EINA_ARG_NONNULL(1);
162/** 162/**
163 * @brief Appends a string to a buffer, reallocating as necessary. 163 * @brief Appends a string to a buffer, reallocating as necessary.
164 * 164 *
165 * @param buf The string buffer. 165 * @param[in,out] buf The string buffer.
166 * @param str The string to append. 166 * @param[in] str The string to append.
167 * @return #EINA_TRUE on success, #EINA_FALSE on failure such as if 167 * @return #EINA_TRUE on success, #EINA_FALSE on failure such as if
168 * @p str could not be appended. 168 * @p str could not be appended.
169 * 169 *
@@ -179,8 +179,8 @@ EAPI Eina_Bool eina_strbuf_append(Eina_Strbuf *buf, const char *str) EINA_ARG_NO
179/** 179/**
180 * @brief Appends an escaped string to a buffer, reallocating as necessary. 180 * @brief Appends an escaped string to a buffer, reallocating as necessary.
181 * 181 *
182 * @param buf The string buffer. 182 * @param[in,out] buf The string buffer.
183 * @param str The string to append. 183 * @param[in] str The string to append.
184 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be appended. 184 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be appended.
185 * 185 *
186 * This function escapes and then appends the string @p str to @p buf. 186 * This function escapes and then appends the string @p str to @p buf.
@@ -191,9 +191,9 @@ EAPI Eina_Bool eina_strbuf_append_escaped(Eina_Strbuf *buf, const char *str) EIN
191 * @brief Appends a string to a buffer, reallocating as necessary, 191 * @brief Appends a string to a buffer, reallocating as necessary,
192 * limited by the given length. 192 * limited by the given length.
193 * 193 *
194 * @param buf The string buffer. 194 * @param[in,out] buf The string buffer.
195 * @param str The string to append. 195 * @param[in] str The string to append.
196 * @param maxlen The maximum number of characters to append. 196 * @param[in] maxlen The maximum number of characters to append.
197 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be appended. 197 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be appended.
198 * 198 *
199 * This function appends at most @p maxlen characters of @p str to 199 * This function appends at most @p maxlen characters of @p str to
@@ -212,9 +212,9 @@ EAPI Eina_Bool eina_strbuf_append_n(Eina_Strbuf *buf, const char *str, size_t ma
212 * @brief Appends a string of exact length to a buffer, reallocating as 212 * @brief Appends a string of exact length to a buffer, reallocating as
213 * necessary. 213 * necessary.
214 * 214 *
215 * @param buf The string buffer. 215 * @param[in,out] buf The string buffer.
216 * @param str The string to append. 216 * @param[in] str The string to append.
217 * @param length The exact length to use. 217 * @param[in] length The exact length to use.
218 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be appended. 218 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be appended.
219 * 219 *
220 * This function appends @p str to @p buf. @p str must be of size at 220 * This function appends @p str to @p buf. @p str must be of size at
@@ -231,8 +231,8 @@ EAPI Eina_Bool eina_strbuf_append_length(Eina_Strbuf *buf, const char *str, size
231/** 231/**
232 * @brief Append a slice to a buffer, reallocating as necessary. 232 * @brief Append a slice to a buffer, reallocating as necessary.
233 * 233 *
234 * @param buf The string buffer. 234 * @param[in,out] buf The string buffer.
235 * @param slice The slice to append. 235 * @param[in] slice The slice to append.
236 * @return #EINA_TRUE on success, #EINA_FALSE if @p slice could not be appended. 236 * @return #EINA_TRUE on success, #EINA_FALSE if @p slice could not be appended.
237 * 237 *
238 * This function appends @p slice to @p buf. 238 * This function appends @p slice to @p buf.
@@ -244,8 +244,8 @@ EAPI Eina_Bool eina_strbuf_append_slice(Eina_Strbuf *buf, const Eina_Slice slice
244/** 244/**
245 * @brief Appends an Eina_Strbuf to a buffer, reallocating as necessary. 245 * @brief Appends an Eina_Strbuf to a buffer, reallocating as necessary.
246 * 246 *
247 * @param buf The string buffer. 247 * @param[in,out] buf The string buffer.
248 * @param data The string buffer to append. 248 * @param[in] data The string buffer to append.
249 * @return #EINA_TRUE on success, #EINA_FALSE if @p data could not be appended. 249 * @return #EINA_TRUE on success, #EINA_FALSE if @p data could not be appended.
250 * 250 *
251 * This function appends @p data to @p buf. @p data must be allocated and 251 * This function appends @p data to @p buf. @p data must be allocated and
@@ -264,8 +264,8 @@ EAPI Eina_Bool eina_strbuf_append_buffer(Eina_Strbuf *buf, const Eina_Strbuf *da
264 * @brief Appends a character to a string buffer, reallocating as 264 * @brief Appends a character to a string buffer, reallocating as
265 * necessary. 265 * necessary.
266 * 266 *
267 * @param buf The string buffer. 267 * @param[in,out] buf The string buffer.
268 * @param c The character to append. 268 * @param[in] c The character to append.
269 * @return #EINA_TRUE on success, #EINA_FALSE if @p c could not be appended. 269 * @return #EINA_TRUE on success, #EINA_FALSE if @p c could not be appended.
270 * 270 *
271 * This function appends @p c to @p buf. 271 * This function appends @p c to @p buf.
@@ -275,9 +275,9 @@ EAPI Eina_Bool eina_strbuf_append_char(Eina_Strbuf *buf, char c) EINA_ARG_NONNUL
275/** 275/**
276 * @brief Appends data elements to a buffer using printf-style formatting. 276 * @brief Appends data elements to a buffer using printf-style formatting.
277 * 277 *
278 * @param buf The string buffer. 278 * @param[in,out] buf The string buffer.
279 * @param fmt A formatting string. 279 * @param[in] fmt A formatting string.
280 * @param ... Variable list of data parameters to be appended. 280 * @param[in] ... Variable list of data parameters to be appended.
281 * @return #EINA_TRUE on success, #EINA_FALSE if formatted string could 281 * @return #EINA_TRUE on success, #EINA_FALSE if formatted string could
282 * not be appended. 282 * not be appended.
283 * 283 *
@@ -292,9 +292,9 @@ EAPI Eina_Bool eina_strbuf_append_printf(Eina_Strbuf *buf, const char *fmt, ...)
292/** 292/**
293 * @brief Appends data elements to a string buffer using a va_list. 293 * @brief Appends data elements to a string buffer using a va_list.
294 * 294 *
295 * @param buf The string buffer. 295 * @param[in,out] buf The string buffer.
296 * @param fmt A formatting string. 296 * @param[in] fmt A formatting string.
297 * @param args The variable arguments. 297 * @param[in] args The variable arguments.
298 * @return #EINA_TRUE on success, #EINA_FALSE on failure. 298 * @return #EINA_TRUE on success, #EINA_FALSE on failure.
299 * 299 *
300 * @see eina_strbuf_append_printf() 300 * @see eina_strbuf_append_printf()
@@ -304,9 +304,9 @@ EAPI Eina_Bool eina_strbuf_append_vprintf(Eina_Strbuf *buf, const char *fmt, va_
304/** 304/**
305 * @brief Inserts a string into a buffer, reallocating as necessary. 305 * @brief Inserts a string into a buffer, reallocating as necessary.
306 * 306 *
307 * @param buf The string buffer. 307 * @param[in,out] buf The string buffer.
308 * @param str The string to insert. 308 * @param[in] str The string to insert.
309 * @param pos The position to insert the string. 309 * @param[in] pos The position to insert the string.
310 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be inserted. 310 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be inserted.
311 * 311 *
312 * This function inserts @p str into @p buf at position @p pos. It 312 * This function inserts @p str into @p buf at position @p pos. It
@@ -320,9 +320,9 @@ EAPI Eina_Bool eina_strbuf_insert(Eina_Strbuf *buf, const char *str, size_t pos)
320 * @brief Inserts an escaped string into a buffer, reallocating as 320 * @brief Inserts an escaped string into a buffer, reallocating as
321 * necessary. 321 * necessary.
322 * 322 *
323 * @param buf The string buffer. 323 * @param[in,out] buf The string buffer.
324 * @param str The string to insert. 324 * @param[in] str The string to insert.
325 * @param pos The position to insert the string. 325 * @param[in] pos The position to insert the string.
326 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be inserted. 326 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be inserted.
327 * 327 *
328 * This function escapes and inserts the string @p str into @p buf at 328 * This function escapes and inserts the string @p str into @p buf at
@@ -333,10 +333,10 @@ EAPI Eina_Bool eina_strbuf_insert_escaped(Eina_Strbuf *buf, const char *str, siz
333/** 333/**
334 * @brief Inserts a string of a maximum length into a buffer, reallocating as necessary. 334 * @brief Inserts a string of a maximum length into a buffer, reallocating as necessary.
335 * 335 *
336 * @param buf The string buffer. 336 * @param[in,out] buf The string buffer.
337 * @param str The string to insert. 337 * @param[in] str The string to insert.
338 * @param maxlen The maximum number of chars to insert. 338 * @param[in] maxlen The maximum number of chars to insert.
339 * @param pos The position to insert the string. 339 * @param[in] pos The position to insert the string.
340 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be inserted. 340 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be inserted.
341 * 341 *
342 * This function inserts @p str into @p buf at position @p pos, with at 342 * This function inserts @p str into @p buf at position @p pos, with at
@@ -352,10 +352,10 @@ EAPI Eina_Bool eina_strbuf_insert_n(Eina_Strbuf *buf, const char *str, size_t ma
352/** 352/**
353 * @brief Inserts a string of an exact length into a buffer, reallocating as necessary. 353 * @brief Inserts a string of an exact length into a buffer, reallocating as necessary.
354 * 354 *
355 * @param buf The string buffer. 355 * @param[in,out] buf The string buffer.
356 * @param str The string to insert. 356 * @param[in] str The string to insert.
357 * @param length The exact length to use. 357 * @param[in] length The exact length to use.
358 * @param pos The position to insert the string. 358 * @param[in] pos The position to insert the string.
359 * @return #EINA_TRUE on success, #EINA_FALSE if @p string could not be inserted. 359 * @return #EINA_TRUE on success, #EINA_FALSE if @p string could not be inserted.
360 * 360 *
361 * This function inserts @p str into @p buf. @p str must be no longer 361 * This function inserts @p str into @p buf. @p str must be no longer
@@ -372,9 +372,9 @@ EAPI Eina_Bool eina_strbuf_insert_length(Eina_Strbuf *buf, const char *str, size
372/** 372/**
373 * @brief Insert a slice into a buffer, reallocating as necessary. 373 * @brief Insert a slice into a buffer, reallocating as necessary.
374 * 374 *
375 * @param buf The string buffer. 375 * @param[in,out] buf The string buffer.
376 * @param slice The slice to insert. 376 * @param[in] slice The slice to insert.
377 * @param pos The position to insert the string. 377 * @param[in] pos The position to insert the string.
378 * @return #EINA_TRUE on success, #EINA_FALSE if @p slice could not be inserted. 378 * @return #EINA_TRUE on success, #EINA_FALSE if @p slice could not be inserted.
379 * 379 *
380 * This function inserts @p slice into @p buf at position @p pos. 380 * This function inserts @p slice into @p buf at position @p pos.
@@ -387,9 +387,9 @@ EAPI Eina_Bool eina_strbuf_insert_slice(Eina_Strbuf *buf, const Eina_Slice slice
387 * @brief Inserts a character into a string buffer, reallocating as 387 * @brief Inserts a character into a string buffer, reallocating as
388 * necessary. 388 * necessary.
389 * 389 *
390 * @param buf The string buffer. 390 * @param[in,out] buf The string buffer.
391 * @param c The character to insert. 391 * @param[in] c The character to insert.
392 * @param pos The position to insert the character. 392 * @param[in] pos The position to insert the character.
393 * @return #EINA_TRUE on success, #EINA_FALSE if @p c could not be inserted. 393 * @return #EINA_TRUE on success, #EINA_FALSE if @p c could not be inserted.
394 * 394 *
395 * This function inserts @p c into @p buf at position @p pos. 395 * This function inserts @p c into @p buf at position @p pos.
@@ -399,10 +399,10 @@ EAPI Eina_Bool eina_strbuf_insert_char(Eina_Strbuf *buf, char c, size_t pos) EIN
399/** 399/**
400 * @brief Inserts data elements into a buffer using printf-style formatting. 400 * @brief Inserts data elements into a buffer using printf-style formatting.
401 * 401 *
402 * @param buf The string buffer. 402 * @param[in,out] buf The string buffer.
403 * @param fmt The string to insert. 403 * @param[in] fmt The string to insert.
404 * @param pos The position to insert the string. 404 * @param[in] pos The position to insert the string.
405 * @param ... Variable list of data parameters to be inserted. 405 * @param[in] ... Variable list of data parameters to be inserted.
406 * @return #EINA_TRUE on success, #EINA_FALSE if the string could not be inserted. 406 * @return #EINA_TRUE on success, #EINA_FALSE if the string could not be inserted.
407 * 407 *
408 * This function inserts a string as described by the format @p fmt into @p buf at 408 * This function inserts a string as described by the format @p fmt into @p buf at
@@ -414,10 +414,10 @@ EAPI Eina_Bool eina_strbuf_insert_printf(Eina_Strbuf *buf, const char *fmt, size
414/** 414/**
415 * @brief Inserts data elements into a buffer using a va_list. 415 * @brief Inserts data elements into a buffer using a va_list.
416 * 416 *
417 * @param buf The string buffer. 417 * @param[in,out] buf The string buffer.
418 * @param fmt The string to insert. 418 * @param[in] fmt The string to insert.
419 * @param pos The position to insert the string. 419 * @param[in] pos The position to insert the string.
420 * @param args The variable arguments. 420 * @param[in] args The variable arguments.
421 * @return #EINA_TRUE on success, #EINA_FALSE on failure. 421 * @return #EINA_TRUE on success, #EINA_FALSE on failure.
422 * 422 *
423 * @see eina_strbuf_insert_printf 423 * @see eina_strbuf_insert_printf
@@ -428,8 +428,8 @@ EAPI Eina_Bool eina_strbuf_insert_vprintf(Eina_Strbuf *buf, const char *fmt, siz
428 * @def eina_strbuf_prepend(buf, str) 428 * @def eina_strbuf_prepend(buf, str)
429 * @brief Prepends a string to the given buffer. 429 * @brief Prepends a string to the given buffer.
430 * 430 *
431 * @param buf The string buffer. 431 * @param[in,out] buf The string buffer.
432 * @param str The string to prepend. 432 * @param[in] str The string to prepend.
433 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be prepended. 433 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be prepended.
434 * 434 *
435 * This macro simply calls eina_strbuf_insert() with position 0. 435 * This macro simply calls eina_strbuf_insert() with position 0.
@@ -440,8 +440,8 @@ EAPI Eina_Bool eina_strbuf_insert_vprintf(Eina_Strbuf *buf, const char *fmt, siz
440 * @def eina_strbuf_prepend_escaped(buf, str) 440 * @def eina_strbuf_prepend_escaped(buf, str)
441 * @brief Prepends an escaped string to the given buffer. 441 * @brief Prepends an escaped string to the given buffer.
442 * 442 *
443 * @param buf The string buffer. 443 * @param[in,out] buf The string buffer.
444 * @param str The string to prepend. 444 * @param[in] str The string to prepend.
445 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be prepended. 445 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be prepended.
446 * 446 *
447 * This macro simply calls eina_strbuf_insert_escaped() with position 0. 447 * This macro simply calls eina_strbuf_insert_escaped() with position 0.
@@ -452,9 +452,9 @@ EAPI Eina_Bool eina_strbuf_insert_vprintf(Eina_Strbuf *buf, const char *fmt, siz
452 * @def eina_strbuf_prepend_n(buf, str) 452 * @def eina_strbuf_prepend_n(buf, str)
453 * @brief Prepends an escaped string to the given buffer. 453 * @brief Prepends an escaped string to the given buffer.
454 * 454 *
455 * @param buf The string buffer. 455 * @param[in,out] buf The string buffer.
456 * @param str The string to prepend. 456 * @param[in] str The string to prepend.
457 * @param maxlen The maximum number of chars to prepend. 457 * @param[in] maxlen The maximum number of chars to prepend.
458 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be prepended. 458 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be prepended.
459 * 459 *
460 * This macro simply calls eina_strbuf_insert_n() with position 0. 460 * This macro simply calls eina_strbuf_insert_n() with position 0.
@@ -465,9 +465,9 @@ EAPI Eina_Bool eina_strbuf_insert_vprintf(Eina_Strbuf *buf, const char *fmt, siz
465 * @def eina_strbuf_prepend_length(buf, str) 465 * @def eina_strbuf_prepend_length(buf, str)
466 * @brief Prepends an escaped string to the given buffer. 466 * @brief Prepends an escaped string to the given buffer.
467 * 467 *
468 * @param buf The string buffer. 468 * @param[in,out] buf The string buffer.
469 * @param str The string to prepend. 469 * @param[in] str The string to prepend.
470 * @param length The exact length to use. 470 * @param[in] length The exact length to use.
471 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be prepended. 471 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be prepended.
472 * 472 *
473 * This macro simply calls eina_strbuf_insert_length() with position 0. 473 * This macro simply calls eina_strbuf_insert_length() with position 0.
@@ -478,8 +478,8 @@ EAPI Eina_Bool eina_strbuf_insert_vprintf(Eina_Strbuf *buf, const char *fmt, siz
478 * @def eina_strbuf_prepend_char(buf, str) 478 * @def eina_strbuf_prepend_char(buf, str)
479 * @brief Prepends a character to the given buffer. 479 * @brief Prepends a character to the given buffer.
480 * 480 *
481 * @param buf The string buffer. 481 * @param[in,out] buf The string buffer.
482 * @param c The character to prepend. 482 * @param[in] c The character to prepend.
483 * @return #EINA_TRUE on success, #EINA_FALSE on failure. 483 * @return #EINA_TRUE on success, #EINA_FALSE on failure.
484 * 484 *
485 * This macro simply calls eina_strbuf_insert_char() with position 0. 485 * This macro simply calls eina_strbuf_insert_char() with position 0.
@@ -490,9 +490,9 @@ EAPI Eina_Bool eina_strbuf_insert_vprintf(Eina_Strbuf *buf, const char *fmt, siz
490 * @def eina_strbuf_prepend_printf(buf, fmt, ...) 490 * @def eina_strbuf_prepend_printf(buf, fmt, ...)
491 * @brief Prepends data elements to the given buffer using printf-style formatting. 491 * @brief Prepends data elements to the given buffer using printf-style formatting.
492 * 492 *
493 * @param buf The string buffer. 493 * @param[in,out] buf The string buffer.
494 * @param fmt The string to prepend. 494 * @param[in] fmt The string to prepend.
495 * @param ... Variable list of data elements to prepend. 495 * @param[in] ... Variable list of data elements to prepend.
496 * @return #EINA_TRUE on success, #EINA_FALSE if data could not be prepended. 496 * @return #EINA_TRUE on success, #EINA_FALSE if data could not be prepended.
497 * 497 *
498 * This macro simply calls eina_strbuf_insert_printf() with position 0. 498 * This macro simply calls eina_strbuf_insert_printf() with position 0.
@@ -503,9 +503,9 @@ EAPI Eina_Bool eina_strbuf_insert_vprintf(Eina_Strbuf *buf, const char *fmt, siz
503 * @def eina_strbuf_prepend_vprintf(buf, fmt, args) 503 * @def eina_strbuf_prepend_vprintf(buf, fmt, args)
504 * @brief Prepends the given string to the given buffer. 504 * @brief Prepends the given string to the given buffer.
505 * 505 *
506 * @param buf The string buffer. 506 * @param[in,out] buf The string buffer.
507 * @param fmt The string to prepend. 507 * @param[in] fmt The string to prepend.
508 * @param args The variable arguments. 508 * @param[in] args The variable arguments.
509 * @return #EINA_TRUE on success, #EINA_FALSE if data could not be prepended. 509 * @return #EINA_TRUE on success, #EINA_FALSE if data could not be prepended.
510 * 510 *
511 * This macro simply calls eina_strbuf_insert_vprintf() with position 0. 511 * This macro simply calls eina_strbuf_insert_vprintf() with position 0.
@@ -515,9 +515,9 @@ EAPI Eina_Bool eina_strbuf_insert_vprintf(Eina_Strbuf *buf, const char *fmt, siz
515/** 515/**
516 * @brief Removes a section from the given string buffer. 516 * @brief Removes a section from the given string buffer.
517 * 517 *
518 * @param buf The string buffer. 518 * @param[in,out] buf The string buffer.
519 * @param start The initial (inclusive) byte position to start removal. 519 * @param[in] start The initial (inclusive) byte position to start removal.
520 * @param end The final (non-inclusive) byte position to end removal. 520 * @param[in] end The final (non-inclusive) byte position to end removal.
521 * @return #EINA_TRUE on success, #EINA_FALSE on failure. 521 * @return #EINA_TRUE on success, #EINA_FALSE on failure.
522 * 522 *
523 * This function removes a slice of @p buf, starting at @p start 523 * This function removes a slice of @p buf, starting at @p start
@@ -530,7 +530,7 @@ EAPI Eina_Bool eina_strbuf_remove(Eina_Strbuf *buf, size_t start, size_t end) EI
530/** 530/**
531 * @brief Retrieves a pointer to the contents of a string buffer. 531 * @brief Retrieves a pointer to the contents of a string buffer.
532 * 532 *
533 * @param buf The string buffer. 533 * @param[in] buf The string buffer.
534 * @return The current string in the string buffer. 534 * @return The current string in the string buffer.
535 * 535 *
536 * This function returns the string contained in @p buf. The returned 536 * This function returns the string contained in @p buf. The returned
@@ -546,7 +546,7 @@ EAPI const char *eina_strbuf_string_get(const Eina_Strbuf *buf) EINA_ARG_NONNULL
546/** 546/**
547 * @brief Steals the contents of a string buffer. 547 * @brief Steals the contents of a string buffer.
548 * 548 *
549 * @param buf The string buffer. 549 * @param[in,out] buf The string buffer.
550 * @return The string that was contained in @p buf. 550 * @return The string that was contained in @p buf.
551 * 551 *
552 * This function returns the string contained in @p buf. @p buf is 552 * This function returns the string contained in @p buf. @p buf is
@@ -561,7 +561,7 @@ EAPI char *eina_strbuf_string_steal(Eina_Strbuf *buf) EINA_MALLOC EINA_WARN_UNUS
561/** 561/**
562 * @brief Frees the contents of a string buffer but not the buffer. 562 * @brief Frees the contents of a string buffer but not the buffer.
563 * 563 *
564 * @param buf The string buffer. 564 * @param[in,out] buf The string buffer.
565 * 565 *
566 * This function frees the string contained in @p buf without freeing 566 * This function frees the string contained in @p buf without freeing
567 * @p buf. 567 * @p buf.
@@ -571,7 +571,7 @@ EAPI void eina_strbuf_string_free(Eina_Strbuf *buf) EINA_ARG_NONNULL(1);
571/** 571/**
572 * @brief Retrieves the length of the string buffer's content. 572 * @brief Retrieves the length of the string buffer's content.
573 * 573 *
574 * @param buf The string buffer. 574 * @param[in,out] buf The string buffer.
575 * @return The current length of the string, in bytes. 575 * @return The current length of the string, in bytes.
576 * 576 *
577 * This function returns the length of @p buf. 577 * This function returns the length of @p buf.
@@ -581,10 +581,10 @@ EAPI size_t eina_strbuf_length_get(const Eina_Strbuf *buf) EINA_ARG_NONNULL(1) E
581/** 581/**
582 * @brief Replaces a substring in the buffer with another string. 582 * @brief Replaces a substring in the buffer with another string.
583 * 583 *
584 * @param buf The string buffer. 584 * @param[in,out] buf The string buffer.
585 * @param str The text to match. 585 * @param[in] str The text to match.
586 * @param with The replacement string. 586 * @param[in] with The replacement string.
587 * @param n The indexed occurrence to be replaced. 587 * @param[in] n The indexed occurrence to be replaced.
588 * @return #EINA_TRUE on success, #EINA_FALSE on failure. 588 * @return #EINA_TRUE on success, #EINA_FALSE on failure.
589 * 589 *
590 * This function replaces the n-th occurrence of @p str in @p buf with 590 * This function replaces the n-th occurrence of @p str in @p buf with
@@ -596,9 +596,9 @@ EAPI Eina_Bool eina_strbuf_replace(Eina_Strbuf *buf, const char *str, const char
596 * @def eina_strbuf_replace_first(buf, str, with) 596 * @def eina_strbuf_replace_first(buf, str, with)
597 * @brief Replaces the first occurrence of a substring with another string. 597 * @brief Replaces the first occurrence of a substring with another string.
598 * 598 *
599 * @param buf The string buffer. 599 * @param[in,out] buf The string buffer.
600 * @param str The text to match. 600 * @param[in] str The text to match.
601 * @param with The replacement string. 601 * @param[in] with The replacement string.
602 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be 602 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be
603 * replaced in @p buf. 603 * replaced in @p buf.
604 * 604 *
@@ -610,9 +610,9 @@ EAPI Eina_Bool eina_strbuf_replace(Eina_Strbuf *buf, const char *str, const char
610/** 610/**
611 * @brief Replaces all matching substrings with another string. 611 * @brief Replaces all matching substrings with another string.
612 * 612 *
613 * @param buf The string buffer. 613 * @param[in,out] buf The string buffer.
614 * @param str The text to match. 614 * @param[in] str The text to match.
615 * @param with The replacement string. 615 * @param[in] with The replacement string.
616 * @return Number of replacements made, or @c 0 on failure. 616 * @return Number of replacements made, or @c 0 on failure.
617 * 617 *
618 * This function replaces all the occurrences of @p str in @p buf with 618 * This function replaces all the occurrences of @p str in @p buf with
@@ -623,7 +623,7 @@ EAPI int eina_strbuf_replace_all(Eina_Strbuf *buf, const char *str, const char *
623/** 623/**
624 * @brief Trims the string buffer. 624 * @brief Trims the string buffer.
625 * 625 *
626 * @param buf The string buffer. 626 * @param[in,out] buf The string buffer.
627 * 627 *
628 * This function removes whitespace at the beginning and end of the 628 * This function removes whitespace at the beginning and end of the
629 * buffer's string. 629 * buffer's string.
@@ -633,7 +633,7 @@ EAPI void eina_strbuf_trim(Eina_Strbuf *buf) EINA_ARG_NONNULL(1);
633/** 633/**
634 * @brief Left trims the string buffer. 634 * @brief Left trims the string buffer.
635 * 635 *
636 * @param buf The string buffer. 636 * @param[in,out] buf The string buffer.
637 * 637 *
638 * This function removes whitespace at the beginning of the buffer's 638 * This function removes whitespace at the beginning of the buffer's
639 * string. 639 * string.
@@ -643,7 +643,7 @@ EAPI void eina_strbuf_ltrim(Eina_Strbuf *buf) EINA_ARG_NONNULL(1);
643/** 643/**
644 * @brief Right trims the string buffer. 644 * @brief Right trims the string buffer.
645 * 645 *
646 * @param buf The string buffer. 646 * @param[in,out] buf The string buffer.
647 * 647 *
648 * This function removes whitespace at the end of the buffer's string. 648 * This function removes whitespace at the end of the buffer's string.
649 */ 649 */
@@ -652,7 +652,7 @@ EAPI void eina_strbuf_rtrim(Eina_Strbuf *buf) EINA_ARG_NONNULL(1);
652/** 652/**
653 * @brief Converts the string to lower case. 653 * @brief Converts the string to lower case.
654 * 654 *
655 * @param buf The string buffer. 655 * @param[in,out] buf The string buffer.
656 * 656 *
657 * This function converts all the characters in the buffer's string to 657 * This function converts all the characters in the buffer's string to
658 * lower case. 658 * lower case.
@@ -664,9 +664,9 @@ EAPI void eina_strbuf_tolower(Eina_Strbuf *buf) EINA_ARG_NONNULL(1);
664/** 664/**
665 * @brief Obtains substring from a source string buffer. 665 * @brief Obtains substring from a source string buffer.
666 * 666 *
667 * @param buf The string buffer. 667 * @param[in] buf The string buffer.
668 * @param pos The (0-based) position where the substring starts. 668 * @param[in] pos The (0-based) position where the substring starts.
669 * @param len The length from @p pos that should be copied. 669 * @param[in] len The length from @p pos that should be copied.
670 * @return A string buffer containing the substring, or @c NULL if 670 * @return A string buffer containing the substring, or @c NULL if
671 * invalid parameters were specified. 671 * invalid parameters were specified.
672 * 672 *
@@ -681,7 +681,7 @@ EAPI Eina_Strbuf * eina_strbuf_substr_get(Eina_Strbuf *buf, size_t pos, size_t l
681/** 681/**
682 * @brief Gets a read-only slice of the buffer contents. 682 * @brief Gets a read-only slice of the buffer contents.
683 * 683 *
684 * @param buf The string buffer. 684 * @param[in] buf The string buffer.
685 * @return A read-only slice of the current contents. It may become 685 * @return A read-only slice of the current contents. It may become
686 * invalid as soon as @p buf is changed. 686 * invalid as soon as @p buf is changed.
687 * 687 *
@@ -692,7 +692,7 @@ EAPI Eina_Slice eina_strbuf_slice_get(const Eina_Strbuf *buf) EINA_WARN_UNUSED_R
692/** 692/**
693 * @brief Gets a read-write slice of the buffer contents. 693 * @brief Gets a read-write slice of the buffer contents.
694 * 694 *
695 * @param buf The string buffer. 695 * @param[in] buf The string buffer.
696 * @return A read-write slice for the current contents. It may become 696 * @return A read-write slice for the current contents. It may become
697 * invalid as soon as the @p buf is changed, such as through calls like 697 * invalid as soon as the @p buf is changed, such as through calls like
698 * eina_strbuf_append() or eina_strbuf_remove(). 698 * eina_strbuf_append() or eina_strbuf_remove().
@@ -704,7 +704,7 @@ EAPI Eina_Rw_Slice eina_strbuf_rw_slice_get(const Eina_Strbuf *buf) EINA_WARN_UN
704/** 704/**
705 * @brief Frees the buffer, returning its old contents. 705 * @brief Frees the buffer, returning its old contents.
706 * 706 *
707 * @param buf The string buffer.* 707 * @param[in,out] buf The string buffer.
708 * @return The string contained by buf. The caller must release the 708 * @return The string contained by buf. The caller must release the
709 * memory of the returned string by calling free(). 709 * memory of the returned string by calling free().
710 * 710 *
@@ -715,9 +715,9 @@ EAPI char* eina_strbuf_release(Eina_Strbuf *buf) EINA_WARN_UNUSED_RESULT EINA_AR
715/** 715/**
716 * @brief Appends a strftime-style timestamp to the buffer. 716 * @brief Appends a strftime-style timestamp to the buffer.
717 * 717 *
718 * @param buf The string buffer. 718 * @param[in,out] buf The string buffer.
719 * @param fmt The formatting string. 719 * @param[in] fmt The formatting string.
720 * @param tm The time value. 720 * @param[in] tm The time value.
721 * @return #EINA_TRUE on success, #EINA_FALSE on failure. 721 * @return #EINA_TRUE on success, #EINA_FALSE on failure.
722 * 722 *
723 * This function appends a timestamp to the buffer, formatted using 723 * This function appends a timestamp to the buffer, formatted using
@@ -743,10 +743,10 @@ EAPI Eina_Bool eina_strbuf_append_strftime(Eina_Strbuf *buf, const char *fmt, co
743/** 743/**
744 * @brief Inserts a strftime-style timestamp into the buffer. 744 * @brief Inserts a strftime-style timestamp into the buffer.
745 * 745 *
746 * @param buf The string buffer. 746 * @param[in,out] buf The string buffer.
747 * @param fmt The formatting string. 747 * @param[in] fmt The formatting string.
748 * @param tm The time value. 748 * @param[in] tm The time value.
749 * @param pos The position in the buffer to insert the timestamp. 749 * @param[in] pos The position in the buffer to insert the timestamp.
750 * @return #EINA_TRUE on success, #EINA_FALSE on failure. 750 * @return #EINA_TRUE on success, #EINA_FALSE on failure.
751 * 751 *
752 * This function inserts a timestamp into the buffer, formatted using 752 * This function inserts a timestamp into the buffer, formatted using
@@ -773,9 +773,9 @@ EAPI Eina_Bool eina_strbuf_insert_strftime(Eina_Strbuf *buf, const char *fmt, co
773 * @def eina_strbuf_prepend_strftime(buf, fmt, tm) 773 * @def eina_strbuf_prepend_strftime(buf, fmt, tm)
774 * @brief Prepends a strftime-style timestamp to the buffer. 774 * @brief Prepends a strftime-style timestamp to the buffer.
775 * 775 *
776 * @param buf The string buffer. 776 * @param[in,out] buf The string buffer.
777 * @param fmt The formatting string. 777 * @param[in] fmt The formatting string.
778 * @param tm The time value. 778 * @param[in] tm The time value.
779 * @return #EINA_TRUE on success, #EINA_FALSE if @p tm could not be prepended. 779 * @return #EINA_TRUE on success, #EINA_FALSE if @p tm could not be prepended.
780 * 780 *
781 * This macro simply calls eina_strbuf_insert_strftime() with position 0. 781 * This macro simply calls eina_strbuf_insert_strftime() with position 0.
diff --git a/src/lib/eina/eina_ustrbuf.h b/src/lib/eina/eina_ustrbuf.h
index 4ca8b95805..0030735a5d 100644
--- a/src/lib/eina/eina_ustrbuf.h
+++ b/src/lib/eina/eina_ustrbuf.h
@@ -51,7 +51,7 @@ EAPI Eina_UStrbuf *eina_ustrbuf_new(void) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
51/** 51/**
52 * @brief Creates a new string buffer using the passed string. 52 * @brief Creates a new string buffer using the passed string.
53 * 53 *
54 * @param str The string to manage. 54 * @param[in] str The string to manage.
55 * @return Newly allocated string buffer instance, or @c NULL on error. 55 * @return Newly allocated string buffer instance, or @c NULL on error.
56 * 56 *
57 * This function creates a new unicode string buffer. The passed string 57 * This function creates a new unicode string buffer. The passed string
@@ -70,8 +70,8 @@ EAPI Eina_UStrbuf *eina_ustrbuf_manage_new(Eina_Unicode *str) EINA_MALLOC EINA_W
70/** 70/**
71 * @brief Creates a new string buffer using the passed string. 71 * @brief Creates a new string buffer using the passed string.
72 * 72 *
73 * @param str The string to manage. 73 * @param[in] str The string to manage.
74 * @param length The length of the string. 74 * @param[in] length The length of the string.
75 * @return Newly allocated string buffer instance, or @c NULL on error. 75 * @return Newly allocated string buffer instance, or @c NULL on error.
76 * 76 *
77 * This function creates a new string buffer. The passed string is used 77 * This function creates a new string buffer. The passed string is used
@@ -88,7 +88,7 @@ EAPI Eina_UStrbuf *eina_ustrbuf_manage_new_length(Eina_Unicode *str, size_t leng
88/** 88/**
89 * @brief Frees a string buffer. 89 * @brief Frees a string buffer.
90 * 90 *
91 * @param buf The string buffer to free. 91 * @param[in,out] buf The string buffer to free.
92 * 92 *
93 * This function frees the memory of @p buf. @p buf must have been 93 * This function frees the memory of @p buf. @p buf must have been
94 * created by eina_ustrbuf_new(). 94 * created by eina_ustrbuf_new().
@@ -98,7 +98,7 @@ EAPI void eina_ustrbuf_free(Eina_UStrbuf *buf) EINA_ARG_NONNULL(1);
98/** 98/**
99 * @brief Resets a string buffer. 99 * @brief Resets a string buffer.
100 * 100 *
101 * @param buf The string buffer. 101 * @param[in,out] buf The string buffer.
102 * 102 *
103 * This function resets @p buf: the buffer len is set to 0, and the 103 * This function resets @p buf: the buffer len is set to 0, and the
104 * string data is set to '\\0'. No memory is freed. 104 * string data is set to '\\0'. No memory is freed.
@@ -108,8 +108,8 @@ EAPI void eina_ustrbuf_reset(Eina_UStrbuf *buf) EINA_ARG_NONNULL(1);
108/** 108/**
109 * @brief Appends a string to a buffer, reallocating as necessary. 109 * @brief Appends a string to a buffer, reallocating as necessary.
110 * 110 *
111 * @param buf The string buffer. 111 * @param[in,out] buf The string buffer.
112 * @param str The string to append. 112 * @param[in] str The string to append.
113 * @return #EINA_TRUE on success, #EINA_FALSE on failure such as if 113 * @return #EINA_TRUE on success, #EINA_FALSE on failure such as if
114 * @p str could not be appended. 114 * @p str could not be appended.
115 * 115 *
@@ -125,8 +125,8 @@ EAPI Eina_Bool eina_ustrbuf_append(Eina_UStrbuf *buf, const Eina_Unicode *str) E
125/** 125/**
126 * @brief Appends an escaped string to a buffer, reallocating as necessary. 126 * @brief Appends an escaped string to a buffer, reallocating as necessary.
127 * 127 *
128 * @param buf The string buffer. 128 * @param[in,out] buf The string buffer.
129 * @param str The string to append. 129 * @param[in] str The string to append.
130 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be appended. 130 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be appended.
131 * 131 *
132 * This function appends the escaped string @p str to @p buf. 132 * This function appends the escaped string @p str to @p buf.
@@ -137,9 +137,9 @@ EAPI Eina_Bool eina_ustrbuf_append_escaped(Eina_UStrbuf *buf, const Eina_Unicode
137 * @brief Appends a string to a buffer, reallocating as necessary, 137 * @brief Appends a string to a buffer, reallocating as necessary,
138 * limited by the given length. 138 * limited by the given length.
139 * 139 *
140 * @param buf The string buffer to append to. 140 * @param[in,out] buf The string buffer.
141 * @param str The string to append. 141 * @param[in] str The string to append.
142 * @param maxlen The maximum number of characters to append. 142 * @param[in] maxlen The maximum number of characters to append.
143 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be appended. 143 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be appended.
144 * 144 *
145 * This function appends at most @p maxlen characters of @p str to 145 * This function appends at most @p maxlen characters of @p str to
@@ -158,9 +158,9 @@ EAPI Eina_Bool eina_ustrbuf_append_n(Eina_UStrbuf *buf, const Eina_Unicode *str,
158 * @brief Appends a string of exact length to a buffer, reallocating as 158 * @brief Appends a string of exact length to a buffer, reallocating as
159 * necessary. 159 * necessary.
160 * 160 *
161 * @param buf The string buffer. 161 * @param[in,out] buf The string buffer.
162 * @param str The string to append. 162 * @param[in] str The string to append.
163 * @param length The exact length to use. 163 * @param[in] length The exact length to use.
164 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be appended. 164 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be appended.
165 * 165 *
166 * This function appends @p str to @p buf. @p str must be of size at 166 * This function appends @p str to @p buf. @p str must be of size at
@@ -177,8 +177,8 @@ EAPI Eina_Bool eina_ustrbuf_append_length(Eina_UStrbuf *buf, const Eina_Unicode
177/** 177/**
178 * @brief Appends a slice to a buffer, reallocating as necessary. 178 * @brief Appends a slice to a buffer, reallocating as necessary.
179 * 179 *
180 * @param buf The string buffer. 180 * @param[in,out] buf The string buffer.
181 * @param slice The slice to append. 181 * @param[in] slice The slice to append.
182 * @return #EINA_TRUE on success, #EINA_FALSE if @p slice could not be appended. 182 * @return #EINA_TRUE on success, #EINA_FALSE if @p slice could not be appended.
183 * 183 *
184 * This function appends @p slice to @p buf. 184 * This function appends @p slice to @p buf.
@@ -191,8 +191,8 @@ EAPI Eina_Bool eina_ustrbuf_append_slice(Eina_UStrbuf *buf, const Eina_Slice sli
191 * @brief Appends a character to a string buffer, reallocating as 191 * @brief Appends a character to a string buffer, reallocating as
192 * necessary. 192 * necessary.
193 * 193 *
194 * @param buf The string buffer. 194 * @param[in,out] buf The string buffer.
195 * @param c The char to append. 195 * @param[in] c The char to append.
196 * @return #EINA_TRUE on success, #EINA_FALSE if @p c could not be appended. 196 * @return #EINA_TRUE on success, #EINA_FALSE if @p c could not be appended.
197 * 197 *
198 * This function appends @p c to @p buf. 198 * This function appends @p c to @p buf.
@@ -202,9 +202,9 @@ EAPI Eina_Bool eina_ustrbuf_append_char(Eina_UStrbuf *buf, Eina_Unicode c) EINA_
202/** 202/**
203 * @brief Inserts a string to a buffer, reallocating as necessary. 203 * @brief Inserts a string to a buffer, reallocating as necessary.
204 * 204 *
205 * @param buf The string buffer to insert. 205 * @param[in,out] buf The string buffer.
206 * @param str The string to insert. 206 * @param[in] str The string to insert.
207 * @param pos The position to insert the string. 207 * @param[in] pos The position to insert the string.
208 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be inserted. 208 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be inserted.
209 * 209 *
210 * This function inserts @p str to @p buf at position @p pos. It 210 * This function inserts @p str to @p buf at position @p pos. It
@@ -218,9 +218,9 @@ EAPI Eina_Bool eina_ustrbuf_insert(Eina_UStrbuf *buf, const Eina_Unicode *str, s
218 * @brief Inserts an escaped string to a buffer, reallocating as 218 * @brief Inserts an escaped string to a buffer, reallocating as
219 * necessary. 219 * necessary.
220 * 220 *
221 * @param buf The string buffer. 221 * @param[in,out] buf The string buffer.
222 * @param str The string to insert. 222 * @param[in] str The string to insert.
223 * @param pos The position to insert the string. 223 * @param[in] pos The position to insert the string.
224 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be inserted. 224 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be inserted.
225 * 225 *
226 * This function inserts the escaped string @p str to @p buf at 226 * This function inserts the escaped string @p str to @p buf at
@@ -231,10 +231,10 @@ EAPI Eina_Bool eina_ustrbuf_insert_escaped(Eina_UStrbuf *buf, const Eina_Unicode
231/** 231/**
232 * @brief Inserts a string to a buffer, reallocating as necessary. Limited by maxlen. 232 * @brief Inserts a string to a buffer, reallocating as necessary. Limited by maxlen.
233 * 233 *
234 * @param buf The string buffer. 234 * @param[in,out] buf The string buffer.
235 * @param str The string to insert. 235 * @param[in] str The string to insert.
236 * @param maxlen The maximum number of chars to insert. 236 * @param[in] maxlen The maximum number of chars to insert.
237 * @param pos The position to insert the string. 237 * @param[in] pos The position to insert the string.
238 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be inserted. 238 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be inserted.
239 * 239 *
240 * This function inserts @p str into @p buf at position @p pos, with at 240 * This function inserts @p str into @p buf at position @p pos, with at
@@ -250,10 +250,10 @@ EAPI Eina_Bool eina_ustrbuf_insert_n(Eina_UStrbuf *buf, const Eina_Unicode *str,
250/** 250/**
251 * @brief Inserts a string of exact length to a buffer, reallocating as necessary. 251 * @brief Inserts a string of exact length to a buffer, reallocating as necessary.
252 * 252 *
253 * @param buf The string buffer. 253 * @param[in,out] buf The string buffer.
254 * @param str The string to insert. 254 * @param[in] str The string to insert.
255 * @param length The exact length to use. 255 * @param[in] length The exact length to use.
256 * @param pos The position to insert the string. 256 * @param[in] pos The position to insert the string.
257 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be inserted. 257 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be inserted.
258 * 258 *
259 * This function inserts @p str into @p buf. @p str must be no longer 259 * This function inserts @p str into @p buf. @p str must be no longer
@@ -270,9 +270,9 @@ EAPI Eina_Bool eina_ustrbuf_insert_length(Eina_UStrbuf *buf, const Eina_Unicode
270/** 270/**
271 * @brief Inserts a slice to a buffer, reallocating as necessary. 271 * @brief Inserts a slice to a buffer, reallocating as necessary.
272 * 272 *
273 * @param buf The string buffer. 273 * @param[in,out] buf The string buffer.
274 * @param slice The slice to insert. 274 * @param[in] slice The slice to insert.
275 * @param pos The position to insert the string. 275 * @param[in] pos The position to insert the string.
276 * @return #EINA_TRUE on success, #EINA_FALSE if @p slice could not be inserted. 276 * @return #EINA_TRUE on success, #EINA_FALSE if @p slice could not be inserted.
277 * 277 *
278 * This function inserts @p slice to @p buf at position @p pos. 278 * This function inserts @p slice to @p buf at position @p pos.
@@ -285,9 +285,9 @@ EAPI Eina_Bool eina_ustrbuf_insert_slice(Eina_UStrbuf *buf, const Eina_Slice sli
285 * @brief Inserts a character to a string buffer, reallocating as 285 * @brief Inserts a character to a string buffer, reallocating as
286 * necessary. 286 * necessary.
287 * 287 *
288 * @param buf The string buffer. 288 * @param[in,out] buf The string buffer.
289 * @param c The char to insert. 289 * @param[in] c The char to insert.
290 * @param pos The position to insert the char. 290 * @param[in] pos The position to insert the char.
291 * @return #EINA_TRUE on success, #EINA_FALSE if @p c could not be inserted. 291 * @return #EINA_TRUE on success, #EINA_FALSE if @p c could not be inserted.
292 * 292 *
293 * This function inserts @p c to @p buf at position @p pos. 293 * This function inserts @p c to @p buf at position @p pos.
@@ -298,8 +298,8 @@ EAPI Eina_Bool eina_ustrbuf_insert_char(Eina_UStrbuf *buf, Eina_Unicode c, size_
298 * @def eina_ustrbuf_prepend(buf, str) 298 * @def eina_ustrbuf_prepend(buf, str)
299 * @brief Prepends a string to the given buffer. 299 * @brief Prepends a string to the given buffer.
300 * 300 *
301 * @param buf The string buffer. 301 * @param[in,out] buf The string buffer.
302 * @param str The string to prepend. 302 * @param[in] str The string to prepend.
303 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be prepended. 303 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be prepended.
304 * 304 *
305 * This macro simply calls eina_ustrbuf_insert() with position 0. 305 * This macro simply calls eina_ustrbuf_insert() with position 0.
@@ -310,8 +310,8 @@ EAPI Eina_Bool eina_ustrbuf_insert_char(Eina_UStrbuf *buf, Eina_Unicode c, size_
310 * @def eina_ustrbuf_prepend_escaped(buf, str) 310 * @def eina_ustrbuf_prepend_escaped(buf, str)
311 * @brief Prepends an escaped string to the given buffer. 311 * @brief Prepends an escaped string to the given buffer.
312 * 312 *
313 * @param buf The string buffer. 313 * @param[in,out] buf The string buffer.
314 * @param str The string to prepend. 314 * @param[in] str The string to prepend.
315 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be prepended. 315 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be prepended.
316 * 316 *
317 * This macro simply calls eina_ustrbuf_insert_escaped() with position 0. 317 * This macro simply calls eina_ustrbuf_insert_escaped() with position 0.
@@ -322,9 +322,9 @@ EAPI Eina_Bool eina_ustrbuf_insert_char(Eina_UStrbuf *buf, Eina_Unicode c, size_
322 * @def eina_ustrbuf_prepend_n(buf, str) 322 * @def eina_ustrbuf_prepend_n(buf, str)
323 * @brief Prepends an escaped string to the given buffer. 323 * @brief Prepends an escaped string to the given buffer.
324 * 324 *
325 * @param buf The string buffer. 325 * @param[in,out] buf The string buffer.
326 * @param str The string to prepend. 326 * @param[in] str The string to prepend.
327 * @param maxlen The maximum number of Eina_Unicode *s to prepend. 327 * @param[in] maxlen The maximum number of Eina_Unicode *s to prepend.
328 * @return #EINA_TRUE on success, #EINA_FALSE if @str could not be prepended. 328 * @return #EINA_TRUE on success, #EINA_FALSE if @str could not be prepended.
329 * 329 *
330 * This macro simply calls eina_ustrbuf_insert_n() with position 0. 330 * This macro simply calls eina_ustrbuf_insert_n() with position 0.
@@ -335,9 +335,9 @@ EAPI Eina_Bool eina_ustrbuf_insert_char(Eina_UStrbuf *buf, Eina_Unicode c, size_
335 * @def eina_ustrbuf_prepend_length(buf, str) 335 * @def eina_ustrbuf_prepend_length(buf, str)
336 * @brief Prepends an escaped string to the given buffer. 336 * @brief Prepends an escaped string to the given buffer.
337 * 337 *
338 * @param buf The string buffer. 338 * @param[in,out] buf The string buffer.
339 * @param str The string to prepend. 339 * @param[in] str The string to prepend.
340 * @param length The exact length to use. 340 * @param[in] length The exact length to use.
341 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be prepended. 341 * @return #EINA_TRUE on success, #EINA_FALSE if @p str could not be prepended.
342 * 342 *
343 * This macro simply calls eina_ustrbuf_insert_length() with position 0. 343 * This macro simply calls eina_ustrbuf_insert_length() with position 0.
@@ -348,8 +348,8 @@ EAPI Eina_Bool eina_ustrbuf_insert_char(Eina_UStrbuf *buf, Eina_Unicode c, size_
348 * @def eina_ustrbuf_prepend_char(buf, c) 348 * @def eina_ustrbuf_prepend_char(buf, c)
349 * @brief Prepends a unicode character to the given buffer. 349 * @brief Prepends a unicode character to the given buffer.
350 * 350 *
351 * @param buf The string buffer. 351 * @param[in,out] buf The string buffer.
352 * @param c The Eina_Unicode character to prepend. 352 * @param[in] c The Eina_Unicode character to prepend.
353 * @return #EINA_TRUE on success, #EINA_FALSE if @p c could not be prepended. 353 * @return #EINA_TRUE on success, #EINA_FALSE if @p c could not be prepended.
354 * 354 *
355 * This macro is calling eina_ustrbuf_insert_Eina_Unicode() at position 0. 355 * This macro is calling eina_ustrbuf_insert_Eina_Unicode() at position 0.
@@ -359,10 +359,10 @@ EAPI Eina_Bool eina_ustrbuf_insert_char(Eina_UStrbuf *buf, Eina_Unicode c, size_
359/** 359/**
360 * @brief Removes a section of the given string buffer. 360 * @brief Removes a section of the given string buffer.
361 * 361 *
362 * @param buf The string buffer to remove a slice. 362 * @param[in,out] buf The string buffer to remove a slice.
363 * @param start The initial (inclusive) slice position to start 363 * @param[in] start The initial (inclusive) slice position to start
364 * removing, in bytes. 364 * removing, in bytes.
365 * @param end The final (non-inclusive) slice position to finish 365 * @param[in] end The final (non-inclusive) slice position to finish
366 * removing, in bytes. 366 * removing, in bytes.
367 * @return #EINA_TRUE on success, #EINA_FALSE on failure. 367 * @return #EINA_TRUE on success, #EINA_FALSE on failure.
368 * 368 *
@@ -376,7 +376,7 @@ eina_ustrbuf_remove(Eina_UStrbuf *buf, size_t start, size_t end) EINA_ARG_NONNUL
376/** 376/**
377 * @brief Retrieves a pointer to the contents of a string buffer. 377 * @brief Retrieves a pointer to the contents of a string buffer.
378 * 378 *
379 * @param buf The string buffer. 379 * @param[in] buf The string buffer.
380 * @return The current string in the string buffer. 380 * @return The current string in the string buffer.
381 * 381 *
382 * This function returns the string contained in @p buf. The returned 382 * This function returns the string contained in @p buf. The returned
@@ -392,7 +392,7 @@ eina_ustrbuf_string_get(const Eina_UStrbuf *buf) EINA_ARG_NONNULL(1) EINA_WARN_U
392/** 392/**
393 * @brief Steals the contents of a string buffer. 393 * @brief Steals the contents of a string buffer.
394 * 394 *
395 * @param buf The string buffer. 395 * @param[in] buf The string buffer.
396 * @return The string that was contained in @p buf. 396 * @return The string that was contained in @p buf.
397 * 397 *
398 * This function returns the string contained in @p buf. @p buf is 398 * This function returns the string contained in @p buf. @p buf is
@@ -408,7 +408,7 @@ eina_ustrbuf_string_steal(Eina_UStrbuf *buf) EINA_MALLOC EINA_WARN_UNUSED_RESULT
408/** 408/**
409 * @brief Frees the contents of a string buffer but not the buffer. 409 * @brief Frees the contents of a string buffer but not the buffer.
410 * 410 *
411 * @param buf The string buffer. 411 * @param[in,out] buf The string buffer.
412 * 412 *
413 * This function frees the string contained in @p buf without freeing 413 * This function frees the string contained in @p buf without freeing
414 * @p buf. 414 * @p buf.
@@ -419,7 +419,7 @@ eina_ustrbuf_string_free(Eina_UStrbuf *buf) EINA_ARG_NONNULL(1);
419/** 419/**
420 * @brief Retrieves the length of the string buffer's content. 420 * @brief Retrieves the length of the string buffer's content.
421 * 421 *
422 * @param buf The string buffer. 422 * @param[in] buf The string buffer.
423 * @return The current length of the string, in bytes. 423 * @return The current length of the string, in bytes.
424 * 424 *
425 * This function returns the length of @p buf. 425 * This function returns the length of @p buf.
@@ -430,7 +430,7 @@ eina_ustrbuf_length_get(const Eina_UStrbuf *buf) EINA_ARG_NONNULL(1) EINA_WARN_U
430/** 430/**
431 * @brief Gets a read-only slice of the buffer contents. 431 * @brief Gets a read-only slice of the buffer contents.
432 * 432 *
433 * @param buf The string buffer. 433 * @param[in] buf The string buffer.
434 * @return A read-only slice for the current contents. It may become 434 * @return A read-only slice for the current contents. It may become
435 * invalid as soon as @a buf is changed. 435 * invalid as soon as @a buf is changed.
436 * 436 *
@@ -441,7 +441,7 @@ EAPI Eina_Slice eina_ustrbuf_slice_get(const Eina_UStrbuf *buf) EINA_WARN_UNUSED
441/** 441/**
442 * @brief Gets a read-write slice of the buffer contents. 442 * @brief Gets a read-write slice of the buffer contents.
443 * 443 *
444 * @param buf The string buffer. 444 * @param[in] buf The string buffer.
445 * @return A read-write slice for the current contents. It may become 445 * @return A read-write slice for the current contents. It may become
446 * invalid as soon as the @p buf is changed, such as through calls like 446 * invalid as soon as the @p buf is changed, such as through calls like
447 * eina_ustrbuf_append() or eina_ustrbuf_remove(). 447 * eina_ustrbuf_append() or eina_ustrbuf_remove().
@@ -453,7 +453,7 @@ EAPI Eina_Rw_Slice eina_ustrbuf_rw_slice_get(const Eina_UStrbuf *buf) EINA_WARN_
453/** 453/**
454 * @brief Frees the buffer, returning its old contents. 454 * @brief Frees the buffer, returning its old contents.
455 * 455 *
456 * @param buf The string buffer. 456 * @param[in,out] buf The string buffer.
457 * @return The string contained by buf. The caller must release the 457 * @return The string contained by buf. The caller must release the
458 * memory of the returned string by calling free(). 458 * memory of the returned string by calling free().
459 * 459 *