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

[mdictionary] / src / plugins / xdxf / XdxfDialog.h

diff --git a/src/plugins/xdxf/XdxfDialog.h b/src/plugins/xdxf/XdxfDialog.h
index be241de..8e031f6 100644 (file)
--- a/src/plugins/xdxf/XdxfDialog.h
+++ b/src/plugins/xdxf/XdxfDialog.h
@@ -21,6 +21,8 @@
 
 /*!
     \file XdxfDialog.h
+    \brief Implementation of xdxf plugin's dialogs.
+
     \author Mateusz Półrola <mateusz.polrola@gmail.com>
 */
 
@@ -33,7 +35,6 @@
 #include "xdxfplugin.h"
 
 
-//! Implementation of xdxf 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.
@@ -51,19 +52,18 @@ class XdxfDialog : public QDialog
     Q_OBJECT
 public:
     /*!
-      Describes type of dialog. New means that dialog contains widgets to browse
+        Describes type of dialog. New means that dialog contains widgets to browse
         file system and select dictionary file. Change means that dialog displays
-     information about dictionary.
-      In both types dialog provides widgets to create or delete cache and remove
-     or keep accents.
+        information about dictionary.
+        In both types dialog provides widgets to create or delete cache and remove
+        or keep accents.
     */
     enum XdxfDialogType {New, Change};
 
-    //! Constructor
     /*!
         Creates new xdxf dialog
         \param plugin if created dialog is of type Change it must be set to
-            point to plugin whose settings will be changed
+        point to plugin whose settings will be changed
         \param type describes type of created dialog
         \param parent parent widget of created dialog
     */
@@ -71,10 +71,10 @@ public:
                         XdxfDialogType type = New,
                         QWidget* parent = 0);
 
-    //! \returns settings of plugin
     /*!
         After acceptance of dialog this method returns plugin's settings based on
-         user's choices in dialog.
+        user's choices in dialog.
+        \returns settings of plugin
     */
     Settings* getSettings();
 
@@ -83,22 +83,33 @@ 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:
     //! displays dialog to browse and select file
     void selectFile();
+
+    //! download dictionaries list
     void downloadFile();
+
+    //! set properti _generateCache
     void setGenerateCache(bool);
+
+    //! set properti _accents
     void setAccents(bool);
+
     void fileDownloaded(QString);
 
     #ifdef Q_WS_MAEMO_5
         //! on maemo shows information about checkboxes
         void showCacheInfo();
+
+        //! on maemo shows information about checkboxes
         void showAccentsInfo();
     #endif