fixed api documentation

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

5 files changed, 44 insertions, 6 deletions

diff --git a/src/qmmp/outputfactory.h b/src/qmmp/outputfactory.h
index 5f01bfc31..d77aed8bd 100644
--- a/src/qmmp/outputfactory.h
+++ b/src/qmmp/outputfactory.h
@@ -71,7 +71,6 @@ public:
     /*!
      * Creates volume control object provided by plugin.
      * Returns \b 0 if volume control is not supported by plugin.
-     * @param parent Parent object.
      */
     virtual Volume *createVolume() = 0;
     /*!
diff --git a/src/qmmpui/configdialog.h b/src/qmmpui/configdialog.h
index fb9e94bea..8f55a1f83 100644
--- a/src/qmmpui/configdialog.h
+++ b/src/qmmpui/configdialog.h
@@ -32,16 +32,28 @@ class QListWidgetItem;
 class QTreeWidgetItem;
 
 
-/**
+/*! @brief Configuration dialog class.
     @author Ilya Kotov <forkotov02@hotmail.ru>
 */
 class ConfigDialog : public QDialog
 {
     Q_OBJECT
 public:
+    /*!
+     * Constructor.
+     * @param parent Parent widget
+     */
     ConfigDialog(QWidget *parent = 0);
+    /*!
+     * Destructor
+     */
     virtual ~ConfigDialog();
-
+    /*!
+     * Adds custom page in configuration dialog
+     * @param name Localized name of the custom page
+     * @param widget Custom page instance
+     * @param icon Custom page icon
+     */
     void addPage(const QString &name, QWidget *widget, const QIcon &icon = QIcon());
 
 private slots:
diff --git a/src/qmmpui/playlistmodel.h b/src/qmmpui/playlistmodel.h
index 9663ea478..bfd039be9 100644
--- a/src/qmmpui/playlistmodel.h
+++ b/src/qmmpui/playlistmodel.h
@@ -163,7 +163,7 @@ public:
     /*!
      * Sets the selected state of the item to \b select
      * @param row Number of item.
-     * @param select Selection state (\b true - select, \b false - unselect)
+     * @param selected Selection state (\b true - select, \b false - unselect)
      */
     void setSelected(int row, bool selected = true);
     /*!
diff --git a/src/qmmpui/uihelper.h b/src/qmmpui/uihelper.h
index a5b923838..70ef56712 100644
--- a/src/qmmpui/uihelper.h
+++ b/src/qmmpui/uihelper.h
@@ -87,17 +87,45 @@ public:
      * @param parent Parent widget
      */
     QMenu *createMenu(MenuType type, const QString &title = QString(), QWidget *parent = 0);
-
+    /*!
+     * Opens 'Add File' dialog
+     * @param parent Parent widget
+     * @param model Destination playlist model
+     */
     void addFile(QWidget *parent = qApp->activeWindow(),
                  PlayListModel *model = PlayListManager::instance()->selectedPlayList());
+    /*!
+     * Opens 'Add Directory' dialog
+     * @param parent Parent widget
+     * @param model Destination playlist model
+     */
     void addDirectory(QWidget *parent = qApp->activeWindow(),
                       PlayListModel *model = PlayListManager::instance()->selectedPlayList());
+    /*!
+     * Opens 'Load Playlist' dialog
+     * @param parent Parent widget
+     * @param model Destination playlist model
+     */
     void loadPlayList(QWidget *parent = qApp->activeWindow(),
                      PlayListModel *model = PlayListManager::instance()->selectedPlayList());
+    /*!
+     * Opens 'Save Playlist' dialog
+     * @param parent Parent widget
+     * @param model Destination playlist model
+     */
     void savePlayList(QWidget *parent = qApp->activeWindow(),
                      PlayListModel *model = PlayListManager::instance()->selectedPlayList());
+    /*!
+     * Opens 'Jump To Track' dialog
+     * @param parent Parent widget
+     * @param model Destination playlist model
+     */
     void jumpToTrack(QWidget *parent = qApp->activeWindow(),
                      PlayListModel *model = PlayListManager::instance()->selectedPlayList());
+    /*!
+     * Shows about dialog
+     * @param parent Parent widget
+     */
     void about(QWidget *parent = 0);
     /*!
      * Returns a pointer to the object's instance.
diff --git a/src/qmmpui/uiloader.h b/src/qmmpui/uiloader.h
index 5ea46ccf3..3dfe15073 100644
--- a/src/qmmpui/uiloader.h
+++ b/src/qmmpui/uiloader.h
@@ -46,7 +46,6 @@ public:
     static void select(UiFactory* factory);
     /*!
      * Returns \b true if general plugin is enabled, otherwise returns \b false
-     * @param factory General plugin factory.
      */
     static UiFactory *selected();