aboutsummaryrefslogtreecommitdiff
path: root/src/qmmpui/metadataformatter.h
diff options
context:
space:
mode:
authortrialuser02 <trialuser02@90c681e8-e032-0410-971d-27865f9a5e38>2018-12-04 20:55:36 +0000
committertrialuser02 <trialuser02@90c681e8-e032-0410-971d-27865f9a5e38>2018-12-04 20:55:36 +0000
commit7f1fd1cccfca94740f3c22dd411c847eae8c77d3 (patch)
tree1e1fab10d7804bd63ed55c24758d1cbb6db8f301 /src/qmmpui/metadataformatter.h
parenta704e88f0f4ea78f4ea70f41694ddb9b3510ffd0 (diff)
downloadqmmp-7f1fd1cccfca94740f3c22dd411c847eae8c77d3.tar.gz
qmmp-7f1fd1cccfca94740f3c22dd411c847eae8c77d3.tar.bz2
qmmp-7f1fd1cccfca94740f3c22dd411c847eae8c77d3.zip
updated api documentation
git-svn-id: http://svn.code.sf.net/p/qmmp-dev/code/trunk/qmmp@8488 90c681e8-e032-0410-971d-27865f9a5e38
Diffstat (limited to 'src/qmmpui/metadataformatter.h')
-rw-r--r--src/qmmpui/metadataformatter.h11
1 files changed, 8 insertions, 3 deletions
diff --git a/src/qmmpui/metadataformatter.h b/src/qmmpui/metadataformatter.h
index 1a582b91c..2645e3fe7 100644
--- a/src/qmmpui/metadataformatter.h
+++ b/src/qmmpui/metadataformatter.h
@@ -78,12 +78,16 @@ public:
*/
QString format(const PlayListTrack *item) const;
/*!
- * Converts metadata of \b TrackInfo pointer \b info to one string using template.
+ * Converts metadata of \b TrackInfo reference \b info to one string using template.
* \param info pointer to \b TrackInfo object.
- * \param track Index of track.
+ * \param trackIndex Index of track.
*/
QString format(const TrackInfo &info, int trackIndex = 0) const;
-
+ /*!
+ * Converts metadata of \b TrackInfo pointer \b info to one string using template.
+ * \param info pointer to \b TrackInfo object.
+ * \param trackIndex Index of track.
+ */
QString format(const TrackInfo *info, int trackIndex = 0) const;
/*!
* Returns formatted duration (example: 05:02:03).
@@ -91,6 +95,7 @@ public:
* \param hideZero Setting for zero values output.
* If \b hideZero is \b true, then the function outputs empty string for zero length,
* otherwise outputs "0:00".
+ * \param showMs Adds milliseconds to the end of output (example: 05:02:03.324).
*/
static QString formatDuration(qint64 duration, bool hideZero = true, bool showMs = false);