From: Tsuda Kageyu <tsuda.kageyu@gmail.com>
Date: Fri, 28 Aug 2015 04:36:30 +0000 (+0900)
Subject: Mention that String::toWString()/toCWString() doesn't return UTF-32 string.
X-Git-Tag: v1.10~16
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=e178875b40e952fce8c81577310af194ec0322d8;p=taglib

Mention that String::toWString()/toCWString() doesn't return UTF-32 string.
---

diff --git a/taglib/toolkit/tstring.h b/taglib/toolkit/tstring.h
index 59611ab0..8b739882 100644
--- a/taglib/toolkit/tstring.h
+++ b/taglib/toolkit/tstring.h
@@ -197,7 +197,8 @@ namespace TagLib {
 
     /*!
      * Returns a deep copy of this String as a wstring.  The returned string is
-     * encoded in UTF-16 (without BOM/CPU byte order).
+     * encoded in UTF-16 (without BOM/CPU byte order), not UTF-32 even if wchar_t
+     * is 32-bit wide.
      *
      * \see toCWString()
      */
@@ -226,7 +227,7 @@ namespace TagLib {
     /*!
      * Returns a standard C-style (null-terminated) wide character version of
      * this String.  The returned string is encoded in UTF-16 (without BOM/CPU byte
-     * order).
+     * order), not UTF-32 even if wchar_t is 32-bit wide.
      *
      * The returned string is still owned by this String and should not be deleted
      * by the user.