SoundCore class documentation, fixed other documentation

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

13 files changed, 39 insertions, 40 deletions

diff --git a/src/qmmpui/abstractplaylistitem.h b/src/qmmpui/abstractplaylistitem.h
index cf594e6e3..2294ff73a 100644
--- a/src/qmmpui/abstractplaylistitem.h
+++ b/src/qmmpui/abstractplaylistitem.h
@@ -90,7 +90,7 @@ public:
     /*!
      * Loads one metadata value.
      * @param key Metadata key.
-     * @param key Metadata vlaue.
+     * @param value Metadata value.
      */
     virtual void setMetaData(Qmmp::MetaData key, const QString &value);
     /*!
diff --git a/src/qmmpui/commandlinemanager.h b/src/qmmpui/commandlinemanager.h
index 8f0660fb6..6bae654ee 100644
--- a/src/qmmpui/commandlinemanager.h
+++ b/src/qmmpui/commandlinemanager.h
@@ -46,7 +46,7 @@ public:
      */
     void executeCommand(const QString& opt_str);
     /*!
-     * Return \b true if command \b opt_str is supported, otherwise \b false
+     * Return \b true if command \b opt_str is supported, otherwise returns \b false
      */
     static bool hasOption(const QString &opt_str);
     /*!
diff --git a/src/qmmpui/filedialog.h b/src/qmmpui/filedialog.h
index c5ccff59b..7395ffea0 100644
--- a/src/qmmpui/filedialog.h
+++ b/src/qmmpui/filedialog.h
@@ -115,7 +115,6 @@ public:
      * @param caption Dialog title.
      * @param filters Filer used by file dialog
      * (example: "Audio (*.mp3 *.ogg);;Text files (*.txt);;XML files (*.xml)").
-     * @param selectedFilter Default selected filter.
      *
      * Usage: FileDialog::popup(this, FileDialog::AddDirs, &m_lastDir,
      *                 m_playListModel, SLOT(addFileList(const QStringList&)),
@@ -133,7 +132,7 @@ public:
      */
     static QList <FileDialogFactory*> registeredFactories();
     /*!
-     * Returns \b true if selected file dialog doesn't support nonmodal mode, otherwise \b false
+     * Returns \b true if selected file dialog doesn't support nonmodal mode, otherwise returns \b false
      */
     static bool isModal();
     /*!
@@ -141,7 +140,7 @@ public:
      */
     static void setEnabled(FileDialogFactory *factory);
     /*!
-     * Returns \b true if file dialog \b factory is used by default, otherwise \b false
+     * Returns \b true if file dialog \b factory is used by default, otherwise returns \b false
      */
     static bool isEnabled(FileDialogFactory *factory);
 
@@ -215,7 +214,7 @@ protected:
                                    const QString &filter ,
                                    QString *selectedFilter);
     /*!
-     * Returns \b true if file dialog doesn't support nonmodal mode, otherwise \b false
+     * Returns \b true if file dialog doesn't support nonmodal mode, otherwise returns \b false
      * Subclass should reimplement this function.
      */
     virtual bool modal()const
@@ -258,7 +257,7 @@ protected:
     static FileDialog* defaultInstance();
     /*!
      * Registers file dialog \b factory
-     * Returns \b false if \b factory is already registered, otherwise \b true
+     * Returns \b false if \b factory is already registered, otherwise returns \b true
      */
     static bool registerFactory(FileDialogFactory *factory);
 
diff --git a/src/qmmpui/filedialogfactory.h b/src/qmmpui/filedialogfactory.h
index 115d619d1..d5b790b18 100644
--- a/src/qmmpui/filedialogfactory.h
+++ b/src/qmmpui/filedialogfactory.h
@@ -36,7 +36,8 @@ public:
     {
         hasAbout = FALSE;
     }
-    bool hasAbout;      /*!< Should be \b true if the file dialog plugin has about dialog, otherwise \b false */
+    bool hasAbout;      /*!< Should be \b true if the file dialog plugin has about dialog, otherwise should be
+                         * \b false */
     QString name;       /*!< File dialog plugin full name */
     QString shortName;  /*!< File dialog short name for internal usage */
 };
diff --git a/src/qmmpui/fileloader.h b/src/qmmpui/fileloader.h
index e89f4a166..50899ccba 100644
--- a/src/qmmpui/fileloader.h
+++ b/src/qmmpui/fileloader.h
@@ -62,7 +62,7 @@ public:
     void setDirectoryToLoad(const QString&);
 signals:
     /*!
-     * Emited when new playlist item is available.
+     * Emitted when new playlist item is available.
      * @param item Pointer of the new PlayListItem object.
      */
     void newPlayListItem(PlayListItem *item);
diff --git a/src/qmmpui/general.h b/src/qmmpui/general.h
index e4f636354..244d02114 100644
--- a/src/qmmpui/general.h
+++ b/src/qmmpui/general.h
@@ -52,22 +52,22 @@ public:
     /*!
      * Sets whether the general plugin is enabled.
      * @param factory General plugin factory.
-     * @param enabled Plugin enable state (\b true - enable, \b false - disable)
+     * @param enable Plugin enable state (\b true - enable, \b false - disable)
      */
     static void setEnabled(GeneralFactory* factory, bool enable = TRUE);
     /*!
-     * Return \b true if general plugin is enabled, otherwise \b false
+     * Returns \b true if general plugin is enabled, otherwise returns \b false
      * @param factory General plugin factory.
      */
     static bool isEnabled(GeneralFactory* factory);
 
 signals:
     /*!
-     * Emited when exit() slot is called.
+     * Emitted when exit() slot is called.
      */
     void exitCalled();
     /*!
-     * Emited when toggleVisibility() slot is called.
+     * Emitted when toggleVisibility() slot is called.
      */
     void toggleVisibilityCalled();
 
diff --git a/src/qmmpui/generalfactory.h b/src/qmmpui/generalfactory.h
index c1bcc72ae..02fcedd57 100644
--- a/src/qmmpui/generalfactory.h
+++ b/src/qmmpui/generalfactory.h
@@ -42,12 +42,12 @@ public:
     }
     QString name;           /*!< File dialog plugin full name */
     QString shortName;      /*!< File dialog short name for internal usage */
-    bool hasAbout;          /*!< Should be \b true if plugin has about dialog, otherwise \b false */
-    bool hasSettings;       /*!< Should be \b true if plugin has settings dialog, otherwise \b false */
+    bool hasAbout;          /*!< Should be \b true if plugin has about dialog, otherwise returns \b false */
+    bool hasSettings;       /*!< Should be \b true if plugin has settings dialog, otherwise returns \b false */
     bool visibilityControl; /*!< Should be \b true if plugin can show/hide main window of the player,
-                             * otherwise \b false */
+                             * otherwise returns \b false */
 };
-/*! @brief General plugin interface.
+/*! @brief %General plugin interface.
  * @author Ilya Kotov <forkotov02@hotmail.ru>
  */
 class GeneralFactory
diff --git a/src/qmmpui/generalhandler.h b/src/qmmpui/generalhandler.h
index 179c956d8..fa064f3ee 100644
--- a/src/qmmpui/generalhandler.h
+++ b/src/qmmpui/generalhandler.h
@@ -60,7 +60,7 @@ public:
     /*!
      * Sets whether the general plugin is enabled.
      * @param factory General plugin factory.
-     * @param enabled Plugin enable state (\b true - enable, \b false - disable)
+     * @param enable Plugin enable state (\b true - enable, \b false - disable)
      */
     void setEnabled(GeneralFactory* factory, bool enable);
     /*!
@@ -70,7 +70,7 @@ public:
      */
     void showSettings(GeneralFactory* factory, QWidget* parentWidget);
     /*!
-     * Returns \b true if one of the general plugin can change visibility, otherwise \b false
+     * Returns \b true if one of the general plugin can change visibility, otherwise returns \b false
      */
     bool visibilityControl();
     /*!
@@ -97,7 +97,7 @@ public:
      * Creates menu with type \b type
      * @param type Menu type.
      * @param title Menu title.
-     * @param paren Parent widget
+     * @param parent Parent widget
      */
     QMenu *createMenu(MenuType type, const QString &title = QString(), QWidget *parent = 0);
     /*!
@@ -107,12 +107,12 @@ public:
 
 signals:
     /*!
-     * Emited when some general plugin requires to exit.
+     * Emitted when some general plugin requires to exit.
      * Use it to quit application.
      */
     void exitCalled();
     /*!
-     * Emited when some general plugin requires to toggle visibility.
+     * Emitted when some general plugin requires to toggle visibility.
      * Use it to show/hide player's window.
      */
     void toggleVisibilityCalled();
diff --git a/src/qmmpui/mediaplayer.h b/src/qmmpui/mediaplayer.h
index 51d56a5f0..7c03bf3a3 100644
--- a/src/qmmpui/mediaplayer.h
+++ b/src/qmmpui/mediaplayer.h
@@ -56,7 +56,7 @@ public:
      */
     PlayListModel *playListModel();
     /*!
-     * Returns \b true if "Repeate Track" option is enabled, otherwise \b false
+     * Returns \b true if "Repeate Track" option is enabled, otherwise returns \b false
      */
     bool isRepeatable() const;
 
diff --git a/src/qmmpui/playlistitem.h b/src/qmmpui/playlistitem.h
index dd2898f64..5dc67d2df 100644
--- a/src/qmmpui/playlistitem.h
+++ b/src/qmmpui/playlistitem.h
@@ -64,8 +64,7 @@ public:
      */
     void setSelected(bool select);
     /*!
-     * Return \b true if item is selected, otherwise \b false.
-     *  @param yes State of current (\b true - set flag, \b false - unset flag)
+     * Return \b true if item is selected, otherwise returns \b false.
      */
     bool isSelected() const;
     /*!
@@ -73,7 +72,7 @@ public:
      */
     void setCurrent(bool yes);
     /*!
-     * Returns \b true if the item is the current item; otherwise returns \b false.
+     * Returns \b true if the item is the current item; otherwise returns returns \b false.
      */
     bool isCurrent() const;
     /*!
diff --git a/src/qmmpui/playlistmodel.h b/src/qmmpui/playlistmodel.h
index e22334b07..b3e89aef7 100644
--- a/src/qmmpui/playlistmodel.h
+++ b/src/qmmpui/playlistmodel.h
@@ -47,7 +47,7 @@ struct SimpleSelection
         ;
     }
     /*!
-     * Returns \p true if this selection is valid; otherwise returns \p false.
+     * Returns \p true if this selection is valid; otherwise returns returns \p false.
      */
     inline bool isValid()const
     {
@@ -67,10 +67,10 @@ struct SimpleSelection
     {
         return m_bottom - m_top + 1;
     }
-    int m_bottom;
-    int m_top;
-    int m_anchor;
-    QList<int>m_selected_rows;
+    int m_bottom;               /*!<    */
+    int m_top;                  /*!<    */
+    int m_anchor;               /*!<    */
+    QList<int>m_selected_rows;  /*!< Selected rows numbers */
 };
 /*! @internal
  * @brief Helper class used for tags update after details dialog closing.
@@ -132,12 +132,12 @@ public:
     int currentRow();
     /*!
      * Sets current row number.
-     * Returns \b false if item with this number doesn't exist, otherwise \b true
+     * Returns \b false if item with this number doesn't exist, otherwise returns \b true
      * @param row Number of item.
      */
     bool setCurrent (int row);
     /*!
-     * Returns \b true if \b row is selected, otherwise \b false
+     * Returns \b true if \b row is selected, otherwise returns \b false
      */
     bool isSelected(int row);
     /*!
@@ -148,12 +148,12 @@ public:
     void setSelected(int row, bool select);
     /*!
      * Advances to the next item. Returns \b false if next iten doesn't exist,
-     * otherwise \b true
+     * otherwise returns \b true
      */
     bool next();
     /*!
      * Goes back to the previous item. Returns \b false if previous iten doesn't exist,
-     * otherwise \b true
+     * otherwise returns \b true
      */
     bool previous();
     /*!
@@ -181,7 +181,7 @@ public:
      */
     void setCurrentToQueued();
     /*!
-     * Returns \b true if play queue is empty,otherwise - \b false.
+     * Returns \b true if play queue is empty,otherwise returns - \b false.
      */
     bool isEmptyQueue()const;
     /*!
@@ -339,7 +339,7 @@ public slots:
     /*!
      * Removes previous items and loads list of files (regular files or directories),
      * returns \b TRUE if at least one file has been successfully loaded,
-     * otherwise \b FALSE
+     * otherwise returns \b FALSE
      */
     bool setFileList(const QStringList &l);
     /*!
diff --git a/src/qmmpui/playlistparser.h b/src/qmmpui/playlistparser.h
index 7b9688a52..5197feefe 100644
--- a/src/qmmpui/playlistparser.h
+++ b/src/qmmpui/playlistparser.h
@@ -45,7 +45,7 @@ public:
      */
     QStringList getExtensions();
     /*!
-     * Returns \b true if file \b filePath is supported, otherwise \b false
+     * Returns \b true if file \b filePath is supported, otherwise returns \b false
      */
     bool supports(const QString &filePath);
     /*!
diff --git a/src/qmmpui/playstate.h b/src/qmmpui/playstate.h
index a2b525f7d..554afcf11 100644
--- a/src/qmmpui/playstate.h
+++ b/src/qmmpui/playstate.h
@@ -31,12 +31,12 @@ class PlayState
 {
 public:
     /*! Makes single step forward through songs list.
-     *  If the step has done returns \b true, otherwise \b false
+     *  If the step has done returns \b true, otherwise returns \b false
      */
     virtual bool next() = 0;
 
     /*! Makes single step back through songs list.
-     *  If the step has done returns \b true, otherwise \b false
+     *  If the step has done returns \b true, otherwise returns \b false
      */
     virtual bool previous() = 0;