more docs for strbuf

SVN revision: 46518
This commit is contained in:
Gustavo Sverzut Barbieri 2010-02-26 20:25:09 +00:00
parent 2511972dde
commit 3a8741c75e
1 changed files with 22 additions and 0 deletions

View File

@ -47,6 +47,17 @@ static Eina_Bool _eina_strbuf_resize(Eina_Strbuf *buf, size_t size);
#define _eina_strbuf_grow(_buf, _size) \
((((_size) + 1) > (_buf)->size) ? _eina_strbuf_resize((_buf), (_size)) : EINA_TRUE)
/**
* @internal
* @brief Initialize the strbuf module.
*
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* This function sets up the strbuf module of Eina. It is called by
* eina_init().
*
* @see eina_init()
*/
Eina_Bool
eina_strbuf_init(void)
{
@ -54,6 +65,17 @@ eina_strbuf_init(void)
return EINA_TRUE;
}
/**
* @internal
* @brief Shut down the strbuf module.
*
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
*
* This function shuts down the strbuf module set up by
* eina_strbuf_init(). It is called by eina_shutdown().
*
* @see eina_shutdown()
*/
Eina_Bool
eina_strbuf_shutdown(void)
{