Added some comment about UTF-16 encoding to String::data().

diff --git a/taglib/toolkit/tstring.cpp b/taglib/toolkit/tstring.cpp
index 0151f784368fd9553cda04c0b96f15c1f440ab6b..603455a1724c31633e16bb0be24fbd60c764cf2c 100644 (file)
--- a/taglib/toolkit/tstring.cpp
+++ b/taglib/toolkit/tstring.cpp
@@ -457,8 +457,7 @@ ByteVector String::data(Type t) const
       ByteVector v(2 + size() * 2, 0);
       char *p = v.data();
 
-      // Assume that if we're doing UTF16 and not UTF16BE that we want little
-      // endian encoding.  (Byte Order Mark)
+      // We use little-endian encoding here and need a BOM.
 
       *p++ = '\xff';
       *p++ = '\xfe';

diff --git a/taglib/toolkit/tstring.h b/taglib/toolkit/tstring.h
index 2cff5a4b037ed46c2e9b4d595dfc2af4feb74cd7..795e913f901cd45fd097c29673df2b96656ac2ad 100644 (file)
--- a/taglib/toolkit/tstring.h
+++ b/taglib/toolkit/tstring.h
@@ -334,6 +334,9 @@ namespace TagLib {
      * UTF8, this will return a vector of 8 bit characters, otherwise it will use
      * 16 bit characters.
      *
+     * \note If \a t is UTF16, the returned data is encoded in little-endian
+     * format and has a BOM.
+     *
      * \note The returned data is not null terminated.
      */
     ByteVector data(Type t) const;