From ae33fdc0a3898d45896d4670f64e140deb78e35c Mon Sep 17 00:00:00 2001 From: trialuser02 Date: Thu, 12 Mar 2009 16:43:53 +0000 Subject: playlist format api documentation git-svn-id: http://svn.code.sf.net/p/qmmp-dev/code/trunk/qmmp@843 90c681e8-e032-0410-971d-27865f9a5e38 --- src/qmmpui/playlistparser.h | 34 +++++++++++++++++++++++++++------- 1 file changed, 27 insertions(+), 7 deletions(-) (limited to 'src/qmmpui/playlistparser.h') diff --git a/src/qmmpui/playlistparser.h b/src/qmmpui/playlistparser.h index a3ff358e3..7b9688a52 100644 --- a/src/qmmpui/playlistparser.h +++ b/src/qmmpui/playlistparser.h @@ -22,24 +22,44 @@ #include - class PlaylistFormat; -/** - @author Ilya Kotov -*/ +/*! @brief The PlaylistParser class provides a simple api to access playlist format plugins. + * @author Ilya Kotov + */ class PlaylistParser : public QObject { -Q_OBJECT + Q_OBJECT public: + /*! + * Object constructor, + * @param parent Parent object + */ PlaylistParser(QObject *parent); - + /*! + * Destructor + */ ~PlaylistParser(); - + /*! + * Returns a list of supported file extensions. + */ QStringList getExtensions(); + /*! + * Returns \b true if file \b filePath is supported, otherwise \b false + */ bool supports(const QString &filePath); + /*! + * Returns a list of the installed playlist formats. + */ QList formats(); + /*! + * Returns a pointer to the object's instance. + */ static PlaylistParser* instance(); + /*! + * Finds playlist format by file path \b filePath + * Returns \b 0 if file \b filePath is unsupported. + */ PlaylistFormat *findByPath(const QString &filePath); private: -- cgit v1.2.3-13-gbd6f