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

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

diff --git a/src/plugins/stardict/StarDictDialog.h b/src/plugins/stardict/StarDictDialog.h
index 99f581b..5344243 100644 (file)
--- a/src/plugins/stardict/StarDictDialog.h
+++ b/src/plugins/stardict/StarDictDialog.h
@@ -18,9 +18,13 @@
     Copyright 2010 Comarch S.A.
 
 *******************************************************************************/
-/*! \file XdxfDictDialog.h
+/*!
+    \file StarDictDialog.h
+    \brief Class launches dialog which generates a new dictionary, or changes
+    settings
+
+    \author Mateusz Półrola
 */
-//Created by Mateusz Półrola
 
 #ifndef STARDICTDIALOG_H
 #define STARDICTDIALOG_H
@@ -30,13 +34,12 @@
 class StarDictPlugin;
 
 
-//! Implementation of DictDialog interface for xdxf plugin
 class StarDictDialog : public DictDialog {
     Q_OBJECT
 public:
     explicit StarDictDialog(StarDictPlugin* plugin, QObject *parent = 0);
     /*!
-        Shows "add new xdxf dictionary" dialog and returns settings of a new dict
+        Shows "add new starDict dictionary" dialog and returns settings of a new dict
         \param parent parent widget on which dialog will be displayed
     */
     Settings* addNewDictionary(QWidget *parent);
@@ -47,8 +50,10 @@ public:
     */
     void changeSettings(QWidget *parent);
 
+    //! return a pointer to parent Dialog
     QWidget* lastDialogParent();
 
+    //! set a pointer to parent Dialog
     void setLastDialogParent(QWidget*);
 
 private: