gconvert: mention that the g_convert len should be in bytes

Some charsets have each char with more than one byte, make it clear that
the length should be in bytes

https://bugzilla.gnome.org/show_bug.cgi?id=730963

diff --git a/glib/gconvert.c b/glib/gconvert.c
index 2be1cbb..1d55fda 100644 (file)
--- a/glib/gconvert.c
+++ b/glib/gconvert.c
@@ -342,7 +342,7 @@ close_converter (GIConv cd)
 /**
  * g_convert_with_iconv:
  * @str:           the string to convert
- * @len:           the length of the string, or -1 if the string is 
+ * @len:           the length of the string in bytes, or -1 if the string is
  *                 nul-terminated (Note that some encodings may allow nul
  *                 bytes to occur inside strings. In that case, using -1
  *                 for the @len parameter is unsafe)
@@ -495,7 +495,7 @@ g_convert_with_iconv (const gchar *str,
 /**
  * g_convert:
  * @str:           the string to convert
- * @len:           the length of the string, or -1 if the string is 
+ * @len:           the length of the string in bytes, or -1 if the string is
  *                 nul-terminated (Note that some encodings may allow nul
  *                 bytes to occur inside strings. In that case, using -1
  *                 for the @len parameter is unsafe)
@@ -574,7 +574,7 @@ g_convert (const gchar *str,
 /**
  * g_convert_with_fallback:
  * @str:          the string to convert
- * @len:          the length of the string, or -1 if the string is 
+ * @len:          the length of the string in bytes, or -1 if the string is
  *                 nul-terminated (Note that some encodings may allow nul
  *                 bytes to occur inside strings. In that case, using -1
  *                 for the @len parameter is unsafe)