From 13a87b473da2f869fe17a4d95d2f36d82f165563 Mon Sep 17 00:00:00 2001 From: Martchus Date: Fri, 24 Apr 2020 23:15:30 +0200 Subject: [PATCH] Improve documentation --- tagvalue.h | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/tagvalue.h b/tagvalue.h index a247554..24fcb36 100644 --- a/tagvalue.h +++ b/tagvalue.h @@ -410,8 +410,13 @@ inline TagDataType TagValue::type() const /*! * \brief Converts the value of the current TagValue object to its equivalent * std::string representation. + * \param result Specifies the string to store the result. * \param encoding Specifies the encoding to to be used; set to TagTextEncoding::Unspecified to use the * present encoding without any character set conversion. + * \remarks + * - Not all types can be converted to a string, eg. TagDataType::Picture, TagDataType::Binary and + * TagDataType::Unspecified will always fail to convert. + * - If UTF-16 is the desired output \a encoding, it makes sense to use the toWString() method instead. * \throws Throws ConversionException on failure. */ inline std::string TagValue::toString(TagTextEncoding encoding) const @@ -448,7 +453,7 @@ inline bool TagValue::isNull() const } /*! - * \brief Returns whether an empty value is assigned. + * \brief Returns whether no or an empty value is assigned. * * An empty string and empty binary or picture data counts as empty so this function will return * true for those. However, the integer 0, a TimeSpan of zero length, ... are not considered empty