lib/util/charset/util_unistr: clarify the comment header for strlen_m().
authorMichael Adam <obnox@samba.org>
Sun, 31 Oct 2010 07:02:17 +0000 (08:02 +0100)
committerMichael Adam <obnox@samba.org>
Wed, 3 Nov 2010 22:45:20 +0000 (22:45 +0000)
lib/util/charset/util_unistr.c

index 74b453bf464d23883c75868662a93be930e8590a..410547400d75a64e3e65a31e80044a84b8e22fb5 100644 (file)
@@ -324,12 +324,13 @@ _PUBLIC_ size_t strlen_m_ext_term(const char *s, const charset_t src_charset,
        return strlen_m_ext(s, src_charset, dst_charset) + 1;
 }
 
-
 /**
- Count the number of UCS2 characters in a string. Normally this will
- be the same as the number of bytes in a string for single byte strings,
- but will be different for multibyte.
-**/
+ * Calculate the number of 16-bit units that would be needed to convert
+ * the input string which is expected to be in CH_UNIX encoding to UTF16.
+ *
+ * This will be the same as the number of bytes in a string for single
+ * byte strings, but will be different for multibyte.
+ */
 _PUBLIC_ size_t strlen_m(const char *s)
 {
        return strlen_m_ext(s, CH_UNIX, CH_UTF16LE);