From 7f1fd1cccfca94740f3c22dd411c847eae8c77d3 Mon Sep 17 00:00:00 2001 From: trialuser02 Date: Tue, 4 Dec 2018 20:55:36 +0000 Subject: updated api documentation git-svn-id: http://svn.code.sf.net/p/qmmp-dev/code/trunk/qmmp@8488 90c681e8-e032-0410-971d-27865f9a5e38 --- src/qmmpui/metadataformatter.h | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) (limited to 'src/qmmpui/metadataformatter.h') 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); -- cgit v1.2.3-13-gbd6f