diff options
| author | Colin Walters <walters@verbum.org> | 2012-02-29 12:37:24 -0500 |
|---|---|---|
| committer | Colin Walters <walters@verbum.org> | 2012-02-29 13:09:41 -0500 |
| commit | 80611295ab56dd95add95a9600ba8bc88d5e9a62 (patch) | |
| tree | beaba0fee418c1ba5eadebc95d7fb4e943811989 | |
| parent | ede8707129389d6a795b9d23de2554b0d656e2f5 (diff) | |
| download | glib-80611295ab56dd95add95a9600ba8bc88d5e9a62.tar.gz | |
g_uri_unescape_segment: Mention (allow-none)/%NULL in documentation
| -rw-r--r-- | glib/gurifuncs.c | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/glib/gurifuncs.c b/glib/gurifuncs.c index 25b098d29..d4382053e 100644 --- a/glib/gurifuncs.c +++ b/glib/gurifuncs.c @@ -63,9 +63,9 @@ unescape_character (const char *scanner) /** * g_uri_unescape_segment: - * @escaped_string: a string. - * @escaped_string_end: a string. - * @illegal_characters: an optional string of illegal characters not to be allowed. + * @escaped_string: (allow-none): A string, may be %NULL + * @escaped_string_end: (allow-none): Pointer to end of @escaped_string, may be %NULL + * @illegal_characters: (allow-none): An optional string of illegal characters not to be allowed, may be %NULL * * Unescapes a segment of an escaped string. * @@ -76,7 +76,9 @@ unescape_character (const char *scanner) * handling. * * Returns: an unescaped version of @escaped_string or %NULL on error. - * The returned string should be freed when no longer needed. + * The returned string should be freed when no longer needed. As a + * special case if %NULL is given for @escaped_string, this function + * will return %NULL. * * Since: 2.16 **/ |