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

Update documentation

This commit is contained in:
Martchus 2017-09-14 21:41:18 +02:00
parent ebcbe092a4
commit 098c54e016
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
mediafileinfo.cpp
View File

@ -631,8 +631,7 @@ bool MediaFileInfo::createAppropriateTags(bool treatUnknownFilesAsMp3Files, TagU
* will be created to replace the old file.
*
* \throws Throws std::ios_base::failure when an IO error occurs.
* \throws Throws Media::Failure or a derived exception when a making
* error occurs.
* \throws Throws Media::Failure or a derived exception when a making error occurs.
*
* \remarks Tags and tracks need to be parsed without errors before this method can be called.
* All previous parsing results are cleared (using clearParsingResults()). Hence
@ -1352,7 +1351,8 @@ NotificationList MediaFileInfo::gatherRelatedNotifications() const
* container format, tracks, tags, ...
*
* This allows a rescan of the file using parsing methods like parseContainerFormat().
* (These methods do nothing if the information to be parsed has already been gathered.)
* Otherwise, these methods do nothing if the information to be parsed has already been
* gathered.
*
* \remarks Any pointers previously returned by tags(), tracks(), ... object are invalidated.
*/

12
statusprovider.cpp
View File

@ -48,7 +48,7 @@ size_t StatusProvider::registerCallback(CallbackFunction callback)
}
/*!
* \brief This protected method is meant to be called by the derived class to add a \a notification.
* \brief This method is meant to be called by the derived class to add a \a notification.
*/
void StatusProvider::addNotification(const Notification &notification)
{
@ -58,7 +58,7 @@ void StatusProvider::addNotification(const Notification &notification)
}
/*!
* \brief This protected method is meant to be called by the derived class to add a notification of the specified
* \brief This method is meant to be called by the derived class to add a notification of the specified
* \a type, \a message and \a context.
*/
void StatusProvider::addNotification(NotificationType type, const string &message, const string &context)
@ -69,7 +69,7 @@ void StatusProvider::addNotification(NotificationType type, const string &messag
}
/*!
* \brief This protected method is meant to be called by the derived class to add all notifications \a from another
* \brief This method is meant to be called by the derived class to add all notifications \a from another
* StatusProvider instance.
*/
void StatusProvider::addNotifications(const StatusProvider &from)
@ -83,10 +83,10 @@ void StatusProvider::addNotifications(const StatusProvider &from)
}
/*!
* \brief This protected method is meant to be called by the derived class to add all notifications \a from another
* \brief This method is meant to be called by the derived class to add all notifications \a from another
* StatusProvider instance.
*
* The specified \a higherContext is concated with the original context string.
* The specified \a higherContext is concatenated with the original context string.
*/
void StatusProvider::addNotifications(const string &higherContext, const StatusProvider &from)
{
@ -99,7 +99,7 @@ void StatusProvider::addNotifications(const string &higherContext, const StatusP
}
/*!
* \brief This protected method is meant to be called by the derived class to add the specified \a notifications.
* \brief This method is meant to be called by the derived class to add the specified \a notifications.
*/
void StatusProvider::addNotifications(const NotificationList &notifications)
{