From: Matthias Clasen <mclasen@redhat.com>
Date: Mon, 8 Mar 2010 05:04:11 +0000 (-0500)
Subject: Minor doc clarification
X-Git-Tag: 2.23.5~10
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=42f042d5fb381151a999e38740720e9244caa6da;p=platform%2Fupstream%2Fglib.git

Minor doc clarification

Spell out that g_utf8_strlen() behaves like strlen() wrt. to
termination. Bug 612040.
---

diff --git a/glib/gutf8.c b/glib/gutf8.c
index a7fbf6e..27b1e4c 100644
--- a/glib/gutf8.c
+++ b/glib/gutf8.c
@@ -215,13 +215,14 @@ g_utf8_prev_char (const gchar *p)
 
 /**
  * g_utf8_strlen:
- * @p: pointer to the start of a UTF-8 encoded string.
+ * @p: pointer to the start of a UTF-8 encoded string
  * @max: the maximum number of bytes to examine. If @max
  *       is less than 0, then the string is assumed to be
- *       nul-terminated. If @max is 0, @p will not be examined and 
+ *       nul-terminated. If @max is 0, @p will not be examined and
  *       may be %NULL.
- * 
- * Returns the length of the string in characters.
+ *
+ * Computes the length of the string in characters, not including
+ * the terminating nul character.
  *
  * Return value: the length of the string in characters
  **/
@@ -245,13 +246,13 @@ g_utf8_strlen (const gchar *p,
     {
       if (max == 0 || !*p)
         return 0;
-      
-      p = g_utf8_next_char (p);          
+
+      p = g_utf8_next_char (p);
 
       while (p - start < max && *p)
         {
           ++len;
-          p = g_utf8_next_char (p);          
+          p = g_utf8_next_char (p);
         }
 
       /* only do the last len increment if we got a complete