mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-08-23 17:38:54 +02:00
Fix some documentation issue in glib/gstrfuncs.c
Apparently, the documentation of g_strcanon() was not really cristal clear, so this new code sample try to make it clear the fact that we are working on the given string and not a copy. Moreover, it provides a way to keep the original string at once. Fix #29
This commit is contained in:
@@ -1988,10 +1988,17 @@ g_strncasecmp (const gchar *s1,
|
|||||||
* changed to the @new_delimiter character. Modifies @string in place,
|
* changed to the @new_delimiter character. Modifies @string in place,
|
||||||
* and returns @string itself, not a copy. The return value is to
|
* and returns @string itself, not a copy. The return value is to
|
||||||
* allow nesting such as
|
* allow nesting such as
|
||||||
* |[<!-- language="C" -->
|
* |[<!-- language="C" -->
|
||||||
* g_ascii_strup (g_strdelimit (str, "abc", '?'))
|
* g_ascii_strup (g_strdelimit (str, "abc", '?'))
|
||||||
* ]|
|
* ]|
|
||||||
*
|
*
|
||||||
|
* In order to modify a copy, you may use `g_strdup()`:
|
||||||
|
* |[<!-- language="C" -->
|
||||||
|
* reformatted = g_strdelimit (g_strdup (const_str), "abc", '?');
|
||||||
|
* ...
|
||||||
|
* g_free (reformatted);
|
||||||
|
* ]|
|
||||||
|
*
|
||||||
* Returns: @string
|
* Returns: @string
|
||||||
*/
|
*/
|
||||||
gchar *
|
gchar *
|
||||||
@@ -2025,10 +2032,17 @@ g_strdelimit (gchar *string,
|
|||||||
* replaces the character with @substitutor. Modifies @string in place,
|
* replaces the character with @substitutor. Modifies @string in place,
|
||||||
* and return @string itself, not a copy. The return value is to allow
|
* and return @string itself, not a copy. The return value is to allow
|
||||||
* nesting such as
|
* nesting such as
|
||||||
* |[<!-- language="C" -->
|
* |[<!-- language="C" -->
|
||||||
* g_ascii_strup (g_strcanon (str, "abc", '?'))
|
* g_ascii_strup (g_strcanon (str, "abc", '?'))
|
||||||
* ]|
|
* ]|
|
||||||
*
|
*
|
||||||
|
* In order to modify a copy, you may use `g_strdup()`:
|
||||||
|
* |[<!-- language="C" -->
|
||||||
|
* reformatted = g_strcanon (g_strdup (const_str), "abc", '?');
|
||||||
|
* ...
|
||||||
|
* g_free (reformatted);
|
||||||
|
* ]|
|
||||||
|
*
|
||||||
* Returns: @string
|
* Returns: @string
|
||||||
*/
|
*/
|
||||||
gchar *
|
gchar *
|
||||||
|
Reference in New Issue
Block a user