[glib] gutf8: Clarify documentation for g_utf8_get_char_validated()



commit 69b4c72fe58dfa7525446bbdd4759b871c10547c
Author: Philip Withnall <withnall endlessm com>
Date:   Fri Mar 17 12:09:36 2017 +0000

    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

 glib/gutf8.c |    5 ++---
 1 files changed, 2 insertions(+), 3 deletions(-)
---
diff --git a/glib/gutf8.c b/glib/gutf8.c
index 39438cd..6b74e1f 100644
--- a/glib/gutf8.c
+++ b/glib/gutf8.c
@@ -648,9 +648,8 @@ g_utf8_get_char_extended (const  gchar *p,
 /**
  * g_utf8_get_char_validated:
  * @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
- *     if @p is nul-terminated
- * 
+ * @max_len: the maximum number of bytes to read, or -1 if @p is nul-terminated
+ *
  * Convert a sequence of bytes encoded as UTF-8 to a Unicode character.
  * This function checks for incomplete characters, for invalid characters
  * such as characters that are out of the range of Unicode, and for


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]