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

doc: Cross-reference methods for tag/index pos

This commit is contained in:
Martchus 2017-05-22 23:40:30 +02:00
parent 8f5f61c85e
commit 9c3f596699
2 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
abstractcontainer.cpp
View File

@ -178,6 +178,7 @@ bool AbstractContainer::supportsTrackModifications() const
* \remarks * \remarks
* - It might be required to parse tracks before the index position can be determined. * - It might be required to parse tracks before the index position can be determined.
* - Not be applicable for files composed of multiple segments. * - Not be applicable for files composed of multiple segments.
* \sa MediaFileInfo::indexPosition()
*/ */
ElementPosition AbstractContainer::determineIndexPosition() const ElementPosition AbstractContainer::determineIndexPosition() const
{ {
@ -335,6 +336,7 @@ void AbstractContainer::removeAllTags()
* \remarks * \remarks
* - It might be required to parse tags before the tag position can be determined. * - It might be required to parse tags before the tag position can be determined.
* - Not be applicable for files composed of multiple segments. * - Not be applicable for files composed of multiple segments.
* \sa MediaFileInfo::tagPosition()
*/ */
ElementPosition AbstractContainer::determineTagPosition() const ElementPosition AbstractContainer::determineTagPosition() const
{ {

3
mediafileinfo.h
View File

@ -511,6 +511,7 @@ inline void MediaFileInfo::setPreferredPadding(size_t preferredPadding)
/*! /*!
* \brief Returns the position (in the output file) where the tag information is written when applying changes. * \brief Returns the position (in the output file) where the tag information is written when applying changes.
* \sa setTagPosition() * \sa setTagPosition()
* \remarks To determine the current tag position, use AbstractContainer::determineTagPosition().
*/ */
inline ElementPosition MediaFileInfo::tagPosition() const inline ElementPosition MediaFileInfo::tagPosition() const
{ {
@ -555,7 +556,7 @@ inline void MediaFileInfo::setForceTagPosition(bool forceTagPosition)
/*! /*!
* \brief Returns the position (in the output file) where the index is written when applying changes. * \brief Returns the position (in the output file) where the index is written when applying changes.
* \sa setIndexPosition() * \sa setIndexPosition()
* * \remarks To determine the current index position, use AbstractContainer::determineIndexPosition().
*/ */
inline ElementPosition MediaFileInfo::indexPosition() const inline ElementPosition MediaFileInfo::indexPosition() const
{ {