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/playlistformat.h | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) (limited to 'src/qmmpui/playlistformat.h') diff --git a/src/qmmpui/playlistformat.h b/src/qmmpui/playlistformat.h index c5135486c..7e5b8c537 100644 --- a/src/qmmpui/playlistformat.h +++ b/src/qmmpui/playlistformat.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2006-2008 by Ilya Kotov * + * Copyright (C) 2006-2009 by Ilya Kotov * * forkotov02@hotmail.ru * * * * This program is free software; you can redistribute it and/or modify * @@ -22,16 +22,17 @@ #define _PALYLISTFORMAT_H #include - class AbstractPlaylistItem; -/*! - * Abstract interface for playlist formats. - * + +/*! @brief Abstract interface for playlist formats. * @author Vladimir Kuznetsov */ class PlaylistFormat { public: + /*! + * Object destructor + */ virtual ~PlaylistFormat() { ; @@ -41,25 +42,23 @@ public: * ready file pathes to fill the playlist. */ virtual QStringList decode(const QString& contents) = 0; - /*! * Takes the list of AbstractPlaylistItem objects, should return string of * encoded playlist file */ virtual QString encode(const QList& contents) = 0; - /*! * Returns list of file extensions that current format supports */ virtual QStringList getExtensions()const = 0; - /*! * Verifies is the \b ext file extension supported by current playlist format. */ virtual bool hasFormat(const QString& ext) = 0; - - /// Unique name of playlist format. - virtual QString name()const = 0; + /*! + * Unique name of playlist format. + */ + virtual QString name() const = 0; }; Q_DECLARE_INTERFACE(PlaylistFormat,"PlaylistFormatInterface/1.0"); -- cgit v1.2.3-13-gbd6f