lib/util/charset/util_unistr: clarify the comment header for strlen_m().

1 files changed, 6 insertions, 5 deletions

diff --git a/lib/util/charset/util_unistr.c b/lib/util/charset/util_unistr.c
index 74b453bf46..410547400d 100644
--- a/lib/util/charset/util_unistr.c
+++ b/lib/util/charset/util_unistr.c
@@ -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);