g_uri_unescape_segment: Mention (allow-none)/%NULL in documentation

This commit is contained in:
Colin Walters 2012-02-29 12:37:24 -05:00
parent ede8707129
commit 80611295ab

View File

@ -63,9 +63,9 @@ unescape_character (const char *scanner)
/** /**
* g_uri_unescape_segment: * g_uri_unescape_segment:
* @escaped_string: a string. * @escaped_string: (allow-none): A string, may be %NULL
* @escaped_string_end: a string. * @escaped_string_end: (allow-none): Pointer to end of @escaped_string, may be %NULL
* @illegal_characters: an optional string of illegal characters not to be allowed. * @illegal_characters: (allow-none): An optional string of illegal characters not to be allowed, may be %NULL
* *
* Unescapes a segment of an escaped string. * Unescapes a segment of an escaped string.
* *
@ -76,7 +76,9 @@ unescape_character (const char *scanner)
* handling. * handling.
* *
* Returns: an unescaped version of @escaped_string or %NULL on error. * 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 * Since: 2.16
**/ **/