From 05428e3c1ac4888b841fca3aeb9c7c9b299d2280 Mon Sep 17 00:00:00 2001 From: Colin Walters Date: Fri, 3 Dec 2010 10:36:16 -0500 Subject: [PATCH] glib: Document g_string_free semantics better in the FALSE case --- glib/gstring.c | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/glib/gstring.c b/glib/gstring.c index b151135..8765e56 100644 --- a/glib/gstring.c +++ b/glib/gstring.c @@ -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) -- 2.7.4