2.9.2

[platform/upstream/glib.git] / docs / reference / glib / tmpl / strings.sgml

diff --git a/docs/reference/glib/tmpl/strings.sgml b/docs/reference/glib/tmpl/strings.sgml
index 58cf10c..8a35eeb 100644 (file)
--- a/docs/reference/glib/tmpl/strings.sgml
+++ b/docs/reference/glib/tmpl/strings.sgml
@@ -16,13 +16,16 @@ can be used for binary data with embedded nul bytes.
 
 </para>
 
+<!-- ##### SECTION Stability_Level ##### -->
+
+
 <!-- ##### STRUCT GString ##### -->
 <para>
 The #GString struct contains the public fields of a #GString.
 The <structfield>str</structfield> field points to the character data.
 It may move as text is added.
 The <structfield>len</structfield> field contains the length of the string,
-not including the terminating nul character.
+not including the terminating nul byte.
 </para>
 <para>
 The <structfield>str</structfield> field is nul-terminated and so can be used as an ordinary C
@@ -56,7 +59,7 @@ provided, @init need not be nul-terminated, and can contain embedded nul bytes.
 
 <!-- ##### FUNCTION g_string_sized_new ##### -->
 <para>
-Creates a new #GString, with enough space for @dfl_size characters.
+Creates a new #GString, with enough space for @dfl_size bytes.
 This is useful if you are going to add a lot of text to the string and
 don't want it to be reallocated too often.
 </para>
@@ -67,28 +70,30 @@ don't want it to be reallocated too often.
 
 <!-- ##### FUNCTION g_string_assign ##### -->
 <para>
-Copies the characters from one #GString into another, destroying any previous
-contents. It is rather like the standard <function>strcpy()</function> function, except that
+Copies the bytes from a string into a #GString, destroying any previous
+contents. It is rather like the standard strcpy() function, except that
 you do not have to worry about having enough space to copy the string.
 </para>
 
 @string: the destination #GString. Its current contents are destroyed.
-@rval: the source #GString.
+@rval: the string to copy into @string
 @Returns: the destination #GString.
+<!-- # Unused Parameters # -->
+@val: the string to copy into @string.
 
 
 <!-- ##### MACRO g_string_sprintf ##### -->
 <para>
 Writes a formatted string into a #GString.
-This is similar to the standard <function>sprintf()</function> function,
+This is similar to the standard sprintf() function,
 except that the #GString buffer automatically expands to contain the results.
-The previous contents of the #GString are destroyed.
+The previous contents of the #GString are destroyed. 
 </para>
 
+@Deprecated: This function has been renamed to g_string_printf().
 <!-- # Unused Parameters # -->
 @string: a #GString.
-@format: the string format. See the <function>sprintf()</function>
-documentation.
+@format: the string format. See the sprintf() documentation.
 @Varargs: the parameters to insert into the format string.
 
 
@@ -96,40 +101,38 @@ documentation.
 <para>
 Appends a formatted string onto the end of a #GString.
 This function is is similar to g_string_sprintf() except that
-the text is appended to the #GString.
+the text is appended to the #GString. 
 </para>
 
+@Deprecated: This function has been renamed to g_string_append_printf().
 <!-- # Unused Parameters # -->
 @string: a #GString.
-@format: the string format. See the <function>sprintf()</function>
-documentation.
+@format: the string format. See the sprintf() documentation.
 @Varargs: the parameters to insert into the format string.
 
 
 <!-- ##### FUNCTION g_string_printf ##### -->
 <para>
 Writes a formatted string into a #GString.
-This is similar to the standard <function>sprintf()</function> function,
+This is similar to the standard sprintf() function,
 except that the #GString buffer automatically expands to contain the results.
 The previous contents of the #GString are destroyed.
 </para>
 
 @string: a #GString.
-@format: the string format. See the <function>sprintf()</function>
-documentation.
+@format: the string format. See the printf() documentation.
 @Varargs: the parameters to insert into the format string.
 
 
-<!-- ##### FUNCTION g_string_printfa ##### -->
+<!-- ##### FUNCTION g_string_append_printf ##### -->
 <para>
 Appends a formatted string onto the end of a #GString.
-This function is is similar to g_string_sprintf() except that
+This function is is similar to g_string_printf() except that
 the text is appended to the #GString.
 </para>
 
 @string: a #GString.
-@format: the string format. See the <function>sprintf()</function>
-documentation.
+@format: the string format. See the printf() documentation.
 @Varargs: the parameters to insert into the format string.
 
 
@@ -145,11 +148,11 @@ Adds a string onto the end of a #GString, expanding it if necessary.
 
 <!-- ##### FUNCTION g_string_append_c ##### -->
 <para>
-Adds a character onto the end of a #GString, expanding it if necessary.
+Adds a byte onto the end of a #GString, expanding it if necessary.
 </para>
 
 @string: a #GString.
-@c: the character to append onto the end of the #GString.
+@c: the byte to append onto the end of the #GString.
 @Returns: the #GString.
 
 
@@ -187,11 +190,11 @@ Adds a string on to the start of a #GString, expanding it if necessary.
 
 <!-- ##### FUNCTION g_string_prepend_c ##### -->
 <para>
-Adds a character onto the start of a #GString, expanding it if necessary.
+Adds a byte onto the start of a #GString, expanding it if necessary.
 </para>
 
 @string: a #GString.
-@c: the character to prepend on the start of the #GString.
+@c: the byte to prepend on the start of the #GString.
 @Returns: the #GString.
 
 
@@ -230,12 +233,12 @@ Inserts a copy of a string into a #GString, expanding it if necessary.
 
 <!-- ##### FUNCTION g_string_insert_c ##### -->
 <para>
-Inserts a character into a #GString, expanding it if necessary.
+Inserts a byte into a #GString, expanding it if necessary.
 </para>
 
 @string: a #GString.
-@pos: the position to insert the character.
-@c: the character to insert.
+@pos: the position to insert the byte.
+@c: the byte to insert.
 @Returns: the #GString.
 
 
@@ -265,20 +268,20 @@ Inserts @len bytes of @val into @string at @pos.  Because @len is provided, @val
 
 <!-- ##### FUNCTION g_string_erase ##### -->
 <para>
-Removes @len characters from a #GString, starting at position @pos.
+Removes @len bytes from a #GString, starting at position @pos.
 The rest of the #GString is shifted down to fill the gap.
 </para>
 
 @string: a #GString.
-@pos: the position of the characters to remove.
-@len: the number of characters to remove, or -1 to remove all
-      following characters.
+@pos: the position of the content to remove.
+@len: the number of bytes to remove, or -1 to remove all
+      following bytes.
 @Returns: the #GString.
 
 
 <!-- ##### FUNCTION g_string_truncate ##### -->
 <para>
-Cuts off the end of the GString, leaving the first @len characters.
+Cuts off the end of the GString, leaving the first @len bytes.
 </para>
 
 @string: a #GString.
@@ -304,24 +307,23 @@ 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: the character data of @string (i.e. %NULL if @free_segment is %TRUE)
 
 
 <!-- ##### FUNCTION g_string_up ##### -->
 <para>
-Converts a #GString to upper case.
 </para>
 
-@string: a #GString.
-@Returns: the #GString.
+@string: 
+@Returns: 
 
 
 <!-- ##### FUNCTION g_string_down ##### -->
 <para>
-Converts a #GString to lower case.
 </para>
 
-@string: a #GString.
-@Returns: the #GString.
+@string: 
+@Returns: 
 
 
 <!-- ##### FUNCTION g_string_hash ##### -->