Improve the long description of GString
authorMatthias Clasen <mclasen@redhat.com>
Thu, 8 Jul 2010 23:37:31 +0000 (19:37 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Thu, 8 Jul 2010 23:37:31 +0000 (19:37 -0400)
It is more similar to a Java StringBuffer than to a C string.
See bug 612439.

docs/reference/glib/tmpl/strings.sgml

index cf435a6b6c222e740e4ac0cde1153b9c7da74eec..3c0b1bc32fbccaa2f344a13e47b9c8a648a799d4 100644 (file)
@@ -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 ##### -->