From 9c3f596699f5c5eae735f456dc28265ed2a69a49 Mon Sep 17 00:00:00 2001
From: Martchus <martchus@gmx.net>
Date: Mon, 22 May 2017 23:40:30 +0200
Subject: [PATCH] doc: Cross-reference methods for tag/index pos

---
 abstractcontainer.cpp | 2 ++
 mediafileinfo.h       | 3 ++-
 2 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/abstractcontainer.cpp b/abstractcontainer.cpp
index ffe1df9..c83a454 100644
--- a/abstractcontainer.cpp
+++ b/abstractcontainer.cpp
@@ -178,6 +178,7 @@ bool AbstractContainer::supportsTrackModifications() const
  * \remarks
  * - It might be required to parse tracks before the index position can be determined.
  * - Not be applicable for files composed of multiple segments.
+ * \sa MediaFileInfo::indexPosition()
  */
 ElementPosition AbstractContainer::determineIndexPosition() const
 {
@@ -335,6 +336,7 @@ void AbstractContainer::removeAllTags()
  * \remarks
  * - It might be required to parse tags before the tag position can be determined.
  * - Not be applicable for files composed of multiple segments.
+ * \sa MediaFileInfo::tagPosition()
  */
 ElementPosition AbstractContainer::determineTagPosition() const
 {
diff --git a/mediafileinfo.h b/mediafileinfo.h
index 7b0c170..44328f4 100644
--- a/mediafileinfo.h
+++ b/mediafileinfo.h
@@ -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.
  * \sa setTagPosition()
+ * \remarks To determine the current tag position, use AbstractContainer::determineTagPosition().
  */
 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.
  * \sa setIndexPosition()
- *
+ * \remarks To determine the current index position, use AbstractContainer::determineIndexPosition().
  */
 inline ElementPosition MediaFileInfo::indexPosition() const
 {