Clean and order documentation in source files. Source ready to beta 2 release

[mdictionary] / src / plugins / stardict / StarDialog.h

diff --git a/src/plugins/stardict/StarDialog.h b/src/plugins/stardict/StarDialog.h
index de3ed04..3153491 100644 (file)
--- a/src/plugins/stardict/StarDialog.h
+++ b/src/plugins/stardict/StarDialog.h
@@ -18,9 +18,10 @@
     Copyright 2010 Comarch S.A.
 
 *******************************************************************************/
-
 /*!
-    \file XdxfDialog.cpp
+    \file StarDialog.h
+    \brief Implementation of stardict plugin's dialogs.
+
     \author Mateusz Półrola <mateusz.polrola@gmail.com>
 */
 
@@ -33,17 +34,12 @@
 #include "StarDictPlugin.h"
 
 
-//! Implementation of stardict plugin's dialogs.
 /*!
     This class can create dialogs for adding a new dictionary or changing settings
     of an existing one, based on dialog type passed to contructor.
     When adding a new dictionary dialog contains a button to browse file system and
     select a dictionary file. When changing settings dialog displays basic
     information about dictionary i. e. name, languages and license info.
-    In both types of dialogs there are comboboxes with "cache" and "remove accents"
-    options. On maemo right next to comboboxes are tool buttons which allow to
-    see more information about these options, on desktop the same information is
-    displayed as a tool tip.
     All contents of a dialog are in a scroll area.
 */
 class StarDialog : public QDialog
@@ -61,7 +57,7 @@ public:
 
     //! Constructor
     /*!
-        Creates new xdxf dialog
+        Creates new StarDict dialog
         \param plugin if created dialog is of type Change it must be set to
             point to plugin whose settings will be changed
         \param type describes type of created dialog
@@ -83,9 +79,11 @@ Q_SIGNALS:
     void notify(Notify::NotifyType, QString);
 
 public Q_SLOTS:
-    //! Reimplemented accept method, to check if all necessary fields in
-    //! dialog are correct e. g. dictionary file path
-    //! and saves new settings
+    /*!
+        Reimplemented accept method, to check if all necessary fields in
+        dialog are correct e. g. dictionary file path
+        and saves new settings
+    */
     void accept();
 
 private Q_SLOTS:
@@ -93,10 +91,13 @@ private Q_SLOTS:
     void selectFile();
 
 private:
+    //! create a user interface
     void initializeUI();
 
     //! saves new settings after acceptance of dialog
     void saveSettings();
+
+    //! check that files is compressed
     bool checkFiles();
 
     QLabel* infoLabel;