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

Extend documentation of Tag::size()

This commit is contained in:
Martchus 2021-08-08 00:04:28 +02:00
parent 3f5d5e3098
commit 62e32f085e
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
tag.cpp
View File

@ -123,8 +123,14 @@ std::size_t Tag::insertValues(const Tag &from, bool overwrite)
/*!
* \fn Tag::size()
* \brief Returns the size of the tag in bytes.
* The tag needs to be parsed before.
* \brief Returns the size the tag within the file it is parsed from in bytes.
* \remarks
* - Zero is returned if the tag has not been parsed yet. If the corresponding MediaFileInfo
* objects tags have already been parsed this shouldn't be the case unless the tag is not
* actually present in the file yet, e.g. it has been added via MediaFileInfo::createAppropriateTags()
* but has not been applied yet via MediaFileInfo::applyChanges().
* - Can **not** be used to determine the number of bytes it would require to write the tag
* in its current state. For this, use functions like Mp4Tag::prepareMaking() instead.
*/
/*!