Add note about in-place editing to g_strdelimit() doc.
authorMatthias Clasen <matthiasc@src.gnome.org>
Tue, 5 Aug 2003 21:35:55 +0000 (21:35 +0000)
committerMatthias Clasen <matthiasc@src.gnome.org>
Tue, 5 Aug 2003 21:35:55 +0000 (21:35 +0000)
(#118875, Thomas Vander Stichele)

docs/reference/ChangeLog
docs/reference/glib/tmpl/string_utils.sgml

index 6be1a2b36c7505d723e332c123d305e111e40465..6cf23bbe174ad8b1b006ef328f54077cc4543766 100644 (file)
@@ -1,3 +1,8 @@
+2003-08-05  Matthias Clasen  <maclas@gmx.de>
+
+       * glib/tmpl/string_utils.sgml: Add note about in-place editing to g_strdelimit() doc.
+       (#118875, Thomas Vander Stichele)
+
 2003-07-30  Matthias Clasen  <maclas@gmx.de>
 
        * glib/tmpl/misc_utils.sgml: Move g_getenv() docs inline.
index 4a198443d86dd6c9f3f9b6aa463ebd8f3f047be9..f4ce4158f26e8797d52f442695f2df46a229e3be 100644 (file)
@@ -745,7 +745,9 @@ Removes leading and trailing whitespace from a string.
 <para>
 Converts any delimiter characters in @string to @new_delimiter.
 Any characters in @string which are found in @delimiters are changed
-to the @new_delimiter character.
+to the @new_delimiter character. Modifies @string in place, and returns 
+@string itself, not a copy. The return value is to allow nesting such as
+<literal>g_ascii_strup (g_strdelimit (str, "abc", '?'))</literal>.
 </para>
 
 @string: the string to convert.