playlist format api documentation

git-svn-id: http://svn.code.sf.net/p/qmmp-dev/code/trunk/qmmp@843 90c681e8-e032-0410-971d-27865f9a5e38

1 files changed, 10 insertions, 11 deletions

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 <QStringList>
 
-
 class AbstractPlaylistItem;
-/*!
- * Abstract interface for playlist formats.
- *
+
+/*! @brief Abstract interface for playlist formats.
  * @author Vladimir Kuznetsov <vovanec@gmail.com>
  */
 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<AbstractPlaylistItem*>& 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");