Minor documentation improvements for g_strchug, g_strchomp and g_strstrip.

2005-10-01  Davyd Madeley  <davyd@fugro-fsi.com.au>

        * glib/tmpl/string_utils.sgml: Minor documentation improvements for           g_strchug, g_strchomp and g_strstrip. Brought forward from glib-2-8.

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 5ffbd31ac2d99b606394b778394b6aaa97929eb7..c9db03540b5602708a95a097c7754b93979a660a 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,8 @@
+2005-10-01  Davyd Madeley  <davyd@fugro-fsi.com.au>
+
+       * glib/tmpl/string_utils.sgml: Minor documentation improvements for
+         g_strchug, g_strchomp and g_strstrip. Brought forward from glib-2-8.
+
 2005-08-31  Matthias Clasen  <mclasen@redhat.com>
 
        * glib/tmpl/quarks.sgml: 

diff --git a/docs/reference/glib/tmpl/string_utils.sgml b/docs/reference/glib/tmpl/string_utils.sgml
index 0fce6c4de8588417c8dc0f07f3316b170e36f41a..224cf601d75294da12818c7c7b3afcca924424e2 100644 (file)
--- a/docs/reference/glib/tmpl/string_utils.sgml
+++ b/docs/reference/glib/tmpl/string_utils.sgml
@@ -722,6 +722,13 @@ The typical usage would be something like:
 Removes leading whitespace from a string, by moving the rest of the
 characters forward.
 </para>
+<para>
+This function doesn't allocate or reallocate any memory; it modifies @string
+in place. The pointer to @string is returned to allow the nesting of functions.
+</para>
+<para>
+Also see g_strchomp() and g_strstrip().
+</para>
 
 @string: a string to remove the leading whitespace from.
 @Returns: @string.
@@ -731,6 +738,13 @@ characters forward.
 <para>
 Removes trailing whitespace from a string.
 </para>
+<para>
+This function doesn't allocate or reallocate any memory; it modifies @string in
+place. The pointer to @string is returned to allow the nesting of functions.
+</para>
+<para>
+Also see g_strchug() and g_strstrip().
+</para>
 
 @string: a string to remove the trailing whitespace from.
 @Returns: @string.
@@ -738,7 +752,8 @@ Removes trailing whitespace from a string.
 
 <!-- ##### MACRO g_strstrip ##### -->
 <para>
-Removes leading and trailing whitespace from a string.
+Removes leading and trailing whitespace from a string. See g_strchomp() and
+g_strchug().
 </para>
 
 @string: a string to remove the leading and trailing whitespace from.