gutf8: Clarify documentation for g_utf8_get_char_validated()

There is no such thing as ‘no maximum’ when reading a string. It’s got
to end somewhere.

Signed-off-by: Philip Withnall <withnall@endlessm.com>

https://bugzilla.gnome.org/show_bug.cgi?id=780095
This commit is contained in:
Philip Withnall 2017-03-17 12:09:36 +00:00
parent 1c56a87c08
commit 69b4c72fe5

View File

@ -648,9 +648,8 @@ g_utf8_get_char_extended (const gchar *p,
/** /**
* g_utf8_get_char_validated: * g_utf8_get_char_validated:
* @p: a pointer to Unicode character encoded as UTF-8 * @p: a pointer to Unicode character encoded as UTF-8
* @max_len: the maximum number of bytes to read, or -1, for no maximum or * @max_len: the maximum number of bytes to read, or -1 if @p is nul-terminated
* if @p is nul-terminated *
*
* Convert a sequence of bytes encoded as UTF-8 to a Unicode character. * Convert a sequence of bytes encoded as UTF-8 to a Unicode character.
* This function checks for incomplete characters, for invalid characters * This function checks for incomplete characters, for invalid characters
* such as characters that are out of the range of Unicode, and for * such as characters that are out of the range of Unicode, and for