From 648061b1af18ed69b396f4a9ea9f905c489da520 Mon Sep 17 00:00:00 2001 From: tasn Date: Sun, 12 Jun 2011 07:58:59 +0000 Subject: [PATCH] Eina strbuf: Add csize to documentation. Thanks to Ulrich Eckhardt for the patch git-svn-id: svn+ssh://svn.enlightenment.org/var/svn/e/trunk/eina@60236 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33 --- src/lib/eina_strbuf_common.c | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/src/lib/eina_strbuf_common.c b/src/lib/eina_strbuf_common.c index beaa50a..ad61766 100644 --- a/src/lib/eina_strbuf_common.c +++ b/src/lib/eina_strbuf_common.c @@ -76,6 +76,7 @@ eina_strbuf_common_shutdown(void) * @internal * * init the buffer + * @param csize the character size * @param buf the buffer to init * * @return #EINA_TRUE on success, #EINA_FALSE on failure. @@ -102,6 +103,7 @@ _eina_strbuf_common_init(size_t csize, Eina_Strbuf *buf) * @internal * * resize the buffer + * @param csize the character size * @param buf the buffer to resize * @param size the minimum size of the buffer * @@ -151,6 +153,7 @@ _eina_strbuf_common_resize(size_t csize, Eina_Strbuf *buf, size_t size) * * If required, enlarge the buffer to fit the new size. * + * @param csize the character size * @param buf the buffer to resize * @param size the minimum size of the buffer * @@ -168,6 +171,7 @@ _eina_strbuf_common_grow(size_t csize, Eina_Strbuf *buf, size_t size) * * insert string of known length at random within existing strbuf limits. * + * @param csize the character size * @param buf the buffer to resize, must be valid. * @param str the string to copy, must be valid (!NULL and smaller than @a len) * @param len the amount of bytes in @a str to copy, must be valid. @@ -207,6 +211,7 @@ _eina_strbuf_common_insert_length(size_t csize, * @internal * @brief Create a new string buffer. * + * @param csize the character size * @return Newly allocated string buffer instance. * * This function creates a new string buffer. On error, @c NULL is @@ -257,6 +262,7 @@ eina_strbuf_common_free(Eina_Strbuf *buf) * @internal * @brief Reset a string buffer. * + * @param csize the character size * @param buf The string buffer to reset. * * This function reset @p buf: the buffer len is set to 0, and the @@ -274,6 +280,7 @@ eina_strbuf_common_reset(size_t csize, Eina_Strbuf *buf) * @internal * @brief Append a string to a buffer, reallocating as necessary. * + * @param csize the character size * @param buf The string buffer to append to. * @param str The string to append. * @return #EINA_TRUE on success, #EINA_FALSE on failure. @@ -308,6 +315,7 @@ eina_strbuf_common_append(size_t csize, * @brief Append a string to a buffer, reallocating as necessary, * limited by the given length. * + * @param csize the character size * @param buf The string buffer to append to. * @param str The string to append. * @param maxlen The maximum number of characters to append. @@ -348,6 +356,7 @@ eina_strbuf_common_append_n(size_t csize, * @internal * @brief Append a string of exact length to a buffer, reallocating as necessary. * + * @param csize the character size * @param buf The string buffer to append to. * @param str The string to append. * @param length The exact length to use. @@ -385,6 +394,7 @@ eina_strbuf_common_append_length(size_t csize, * @internal * @brief Insert a string to a buffer, reallocating as necessary. * + * @param csize the character size * @param buf The string buffer to insert. * @param str The string to insert. * @param pos The position to insert the string. @@ -413,6 +423,7 @@ eina_strbuf_common_insert(size_t csize, * @internal * @brief Insert a string to a buffer, reallocating as necessary. Limited by maxlen. * + * @param csize the character size * @param buf The string buffer to insert to. * @param str The string to insert. * @param maxlen The maximum number of chars to insert. @@ -448,6 +459,7 @@ eina_strbuf_common_insert_n(size_t csize, * @internal * @brief Insert a string of exact length to a buffer, reallocating as necessary. * + * @param csize the character size * @param buf The string buffer to insert to. * @param str The string to insert. * @param length The exact length to use. @@ -484,6 +496,7 @@ eina_strbuf_common_insert_length(size_t csize, * @brief Append a character to a string buffer, reallocating as * necessary. * + * @param csize the character size * @param buf The string buffer to append to. * @param c The char to append. * @return #EINA_TRUE on success, #EINA_FALSE on failure. @@ -507,6 +520,7 @@ eina_strbuf_common_append_char(size_t csize, Eina_Strbuf *buf, const void *c) * @brief Insert a character to a string buffer, reallocating as * necessary. * + * @param csize the character size * @param buf The string buffer to insert to. * @param c The char to insert. * @param pos The position to insert the char. @@ -531,6 +545,7 @@ eina_strbuf_common_insert_char(size_t csize, * @internal * @brief Remove a slice of the given string buffer. * + * @param csize the character size * @param buf The string buffer to remove a slice. * @param start The initial (inclusive) slice position to start * removing, in bytes. @@ -592,6 +607,7 @@ eina_strbuf_common_string_get(const Eina_Strbuf *buf) * @internal * @brief Steal the contents of a string buffer. * + * @param csize the character size * @param buf The string buffer to steal. * @return The current string in the string buffer. * @@ -617,6 +633,7 @@ eina_strbuf_common_string_steal(size_t csize, Eina_Strbuf *buf) * @internal * @brief Free the contents of a string buffer but not the buffer. * + * @param csize the character size * @param buf The string buffer to free the string of. * * This function frees the string contained in @p buf without freeing -- 2.7.4