Martchus
/
tagparser
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improve documentation for `TagValue::isNull()`/`TagValue::isEmpty()`

This commit is contained in:
Martchus 2021-12-31 01:15:50 +01:00
parent 532a805254
commit 478b47d114
1 changed files with 9 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
tagvalue.h
View File

@ -504,11 +504,10 @@ inline std::u16string TagValue::toWString(TagTextEncoding encoding) const
/*! /*!
* \brief Returns whether no value is assigned at all. * \brief Returns whether no value is assigned at all.
* * \remarks
* Returns only true for default constructed instances or cleared instances (using TagValue::clearData()). * - Returns only true for default constructed instances or cleared instances (using TagValue::clearData()).
* So for empty strings, the integer 0, a TimeSpan of zero length, ... this function returns true. * So for empty strings, the integer 0, a TimeSpan of zero length, ... this function returns false.
* * - Meta-data such as description and MIME-type is not considered as an assigned value.
* \remarks Meta-data such as description and MIME-type is not considered as an assigned value.
*/ */
inline bool TagValue::isNull() const inline bool TagValue::isNull() const
{ {
@ -517,12 +516,11 @@ inline bool TagValue::isNull() const
/*! /*!
* \brief Returns whether no or an empty value is assigned. * \brief Returns whether no or an empty value is assigned.
* * \remarks
* An empty string and empty binary or picture data counts as empty so this function will return * - 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 * true for those. However, the integer 0, a TimeSpan of zero length, ... are not considered empty
* and this function will return false. * and this function will return false.
* * - Meta-data such as description and MIME-type is not considered as an assigned value.
* \remarks Meta-data such as description and MIME-type is not considered as an assigned value.
*/ */
inline bool TagValue::isEmpty() const inline bool TagValue::isEmpty() const
{ {