From 85e1ef1fba6e56c8fe3f28f1a51dd0ac4b1bd2bf Mon Sep 17 00:00:00 2001 From: Tsuda Kageyu Date: Fri, 15 Nov 2013 15:25:18 +0900 Subject: [PATCH] Amended some comments about the Type parameters of String::ctor() --- taglib/toolkit/tstring.h | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/taglib/toolkit/tstring.h b/taglib/toolkit/tstring.h index e0ab0076..353d6363 100644 --- a/taglib/toolkit/tstring.h +++ b/taglib/toolkit/tstring.h @@ -129,11 +129,21 @@ namespace TagLib { /*! * Makes a deep copy of the data in \a s. + * + * \note This should only be used with the 16-bit codecs UTF16, UTF16BE or + * UTF16LE, when used with other codecs it will simply print a warning and + * exit. UTF16BE or UTF16LE is automatically chosen as default according + * to the CPU byte order */ String(const std::wstring &s, Type t = WCharByteOrder); /*! * Makes a deep copy of the data in \a s. + * + * \note This should only be used with the 16-bit codecs UTF16, UTF16BE or + * UTF16LE, when used with other codecs it will simply print a warning and + * exit. UTF16BE or UTF16LE is automatically chosen as default according + * to the CPU byte order */ String(const wchar_t *s, Type t = WCharByteOrder); @@ -147,6 +157,11 @@ namespace TagLib { /*! * Makes a deep copy of the data in \a c. + * + * \note This should only be used with the 16-bit codecs UTF16, UTF16BE or + * UTF16LE, when used with other codecs it will simply print a warning and + * exit. UTF16BE or UTF16LE is automatically chosen as default according + * to the CPU byte order */ String(wchar_t c, Type t = WCharByteOrder); @@ -161,9 +176,6 @@ namespace TagLib { /*! * Makes a deep copy of the data in \a s. - * - * \note This should only be used with the 8-bit codecs Latin1 and UTF8, when - * used with other codecs it will simply print a warning and exit. */ String(const ByteVector &v, Type t = Latin1);