[glib] glib: Document g_string_free semantics better in the FALSE case

[Colin Walters <walters src gnome org>]

commit 05428e3c1ac4888b841fca3aeb9c7c9b299d2280
Author: Colin Walters <walters verbum org>
Date:   Fri Dec 3 10:36:16 2010 -0500

    glib: Document g_string_free semantics better in the FALSE case

 glib/gstring.c |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)
---
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)