[glib] Improve the long description of GString



commit 0c357a2d149080c4e4fefb29436c03e7879ce437
Author: Matthias Clasen <mclasen redhat com>
Date:   Thu Jul 8 19:37:31 2010 -0400

    Improve the long description of GString
    
    It is more similar to a Java StringBuffer than to a C string.
    See bug 612439.

 docs/reference/glib/tmpl/strings.sgml |    9 +++++----
 1 files changed, 5 insertions(+), 4 deletions(-)
---
diff --git a/docs/reference/glib/tmpl/strings.sgml b/docs/reference/glib/tmpl/strings.sgml
index cf435a6..3c0b1bc 100644
--- a/docs/reference/glib/tmpl/strings.sgml
+++ b/docs/reference/glib/tmpl/strings.sgml
@@ -6,10 +6,11 @@ text buffers which grow automatically as text is added
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-A #GString is similar to a standard C string, except that it grows 
-automatically as text is appended or inserted. Also, it stores the 
-length of the string, so can be used for binary data with embedded 
-nul bytes.
+A #GString is an object that handles the memory management of a C string
+for you. You can think of it as similar to a Java StringBuffer.
+In addition to the string itself, GString stores the length of the string,
+so can be used for binary data with embedded nul bytes. To access the C
+string managed by the GString @string, simply use @string->str.
 </para>
 
 <!-- ##### SECTION See_Also ##### -->



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]