glib: Document g_string_free semantics better in the FALSE case

This commit is contained in:
Colin Walters 2010-12-03 10:36:16 -05:00
parent 426f90e3cf
commit 05428e3c1a

View File

@ -497,7 +497,9 @@ g_string_new_len (const gchar *init,
* @free_segment: if %TRUE the actual character data is freed as well
*
* Frees the memory allocated for the #GString.
* If @free_segment is %TRUE it also frees the character data.
* If @free_segment is %TRUE it also frees the character data. If
* it's %FALSE, the caller gains ownership of the buffer and must
* free it after use with g_free().
*
* Returns: the character data of @string
* (i.e. %NULL if @free_segment is %TRUE)