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.
This commit is contained in:
Davyd Madeley 2005-10-01 02:48:35 +00:00 committed by Davyd Madeley
parent 53746f3fe7
commit ef030130ab
2 changed files with 21 additions and 1 deletions

View File

@ -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:

View File

@ -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.