Improve documentation

abstracttrack.cpp

@@ -123,6 +123,9 @@ const char *AbstractTrack::extensionChannelConfigString() const
 
 /*!
  * \brief Returns a label for the track.
+ *
+ * The label contains the ID, type, name and language of the track. It is intended to be used in a menu for
+ * selecting a track from the file.
  */
 string AbstractTrack::label() const
 {

aspectratio.h

@@ -30,6 +30,7 @@ constexpr AspectRatio::AspectRatio() :
 
 /*!
  * \brief Constructs a aspect ratio with the specified \a numerator and \a denominator.
+ * \remarks Allows defining a custom aspect ratio, hence counts as "extended" (see isExtended()).
  */
 constexpr AspectRatio::AspectRatio(uint16 numerator, uint16 denominator) :
     type(0xFF),

backuphelper.cpp

@@ -60,6 +60,7 @@ string &backupDirectory()
  * file will be restored by copying.
  *
  * \throws Throws std::ios_base::failure on failure.
+ * \todo Implement callback for progress updates (copy).
  */
 void restoreOriginalFileFromBackupFile(const std::string &originalPath, const std::string &backupPath, NativeFileStream &originalStream, NativeFileStream &backupStream)
 {
@@ -104,7 +105,7 @@ void restoreOriginalFileFromBackupFile(const std::string &originalPath, const st
  * \param backupStream Specifies a std::fstream for creating the backup file.
  *
  * This helper function is used by MediaFileInfo and container implementations to create a backup file
- * when applying changes. The path of the created backup file is set to \a backup path.
+ * when applying changes. The specified \a backupPath is set to the path of the created backup file.
  * The specified \a backupStream will be closed if currently open. Then it is
  * used to open the backup file using the flags ios_base::in and ios_base::binary.
  *
@@ -117,6 +118,7 @@ void restoreOriginalFileFromBackupFile(const std::string &originalPath, const st
  * the created backup file can be restored using restoreOriginalFileFromBackupFile().
  *
  * \throws Throws std::ios_base::failure on failure.
+ * \todo Implement callback for progress updates (copy).
  */
 void createBackupFile(const std::string &originalPath, std::string &backupPath, NativeFileStream &originalStream, NativeFileStream &backupStream)
 {

matroska/matroskachapter.cpp

@@ -31,13 +31,11 @@ MatroskaChapter::~MatroskaChapter()
 {}
 
 /*!
- * \fn MatroskaChapter::parse()
  * \brief Parses the "ChapterAtom"-element which has been specified when constructing the object.
  * \remarks
  * - Fetches nested chapters but does not parse them.
  * - Clears all previous parsing results.
  */
-
 void MatroskaChapter::internalParse()
 {
     // clear previous values and status