From: Matthias Clasen <maclas@gmx.de>
Date: Tue, 21 Jan 2003 22:24:00 +0000 (+0000)
Subject: Document the return value of g_string_free().
X-Git-Url: http://git.openbox.org/?a=commitdiff_plain;h=d671206b9e6af3c167d4ff507986437ec22e9bab;p=dana%2Fcg-glib.git

Document the return value of g_string_free().

2003-01-21  Matthias Clasen  <maclas@gmx.de>

	* glib/tmpl/strings.sgml: Document the return value of g_string_free().
---

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index f705c960..73d3856f 100644
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,7 @@
+2003-01-21  Matthias Clasen  <maclas@gmx.de>
+
+	* glib/tmpl/strings.sgml: Document the return value of g_string_free().
+
 2003-01-15  Matthias Clasen  <maclas@gmx.de>
 
 	* gobject/tmpl/gtype.sgml: Fix the description of
diff --git a/docs/reference/glib/tmpl/strings.sgml b/docs/reference/glib/tmpl/strings.sgml
index a3f69b1b..6539dfab 100644
--- a/docs/reference/glib/tmpl/strings.sgml
+++ b/docs/reference/glib/tmpl/strings.sgml
@@ -308,7 +308,7 @@ If @free_segment is %TRUE it also frees the character data.
 
 @string: a #GString.
 @free_segment: if %TRUE the actual character data is freed as well.
-@Returns: 
+@Returns: the character data of @string (i.e. %NULL if @free_segment is %TRUE)
 
 
 <!-- ##### FUNCTION g_string_up ##### -->