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

[mdictionary] / src / mdictionary / gui / DictTypeSelectDialog.h

diff --git a/src/mdictionary/gui/DictTypeSelectDialog.h b/src/mdictionary/gui/DictTypeSelectDialog.h
index 11b1e0a..34b0847 100644 (file)
--- a/src/mdictionary/gui/DictTypeSelectDialog.h
+++ b/src/mdictionary/gui/DictTypeSelectDialog.h
@@ -18,8 +18,11 @@
     Copyright 2010 Comarch S.A.
 
 *******************************************************************************/
-//! \file DictTypeSelectDialog.h
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file DictTypeSelectDialog.h
+    \brief Implements plugin selection dialog
+
+    \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
 
 #ifndef DICTTYPESELECTDIALOG_H
 #define DICTTYPESELECTDIALOG_H
@@ -32,25 +35,24 @@
 #define PLUGIN_ROW_ROLE 99      //TODO remove this
 
 
-//! Implements plugin selection dialog
 /*!
-  Shows list of loaded dictionaries plugins.
+  Shows a list of loaded dictionaries plugins.
   Static function addNewdict will return selected plugin.
 */
 class DictTypeSelectDialog : public QDialog {
     Q_OBJECT
 public:    
-    //! Shows dialog with list of plugins
+    //! Shows dialog with a list of plugins
     /*!
       \param plugins list of loaded plugins
-      \param parent widget
-      \return selected plugin, if user cancels dialog it returns NULL
+      \param parent parent widget
+      \return selected plugin, if user cancels dialog it returns 0 (NULL)
       */
     static CommonDictInterface* addNewDict(
             QList<CommonDictInterface* > plugins,
             QWidget *parent = 0);
 
-    //! Returns plugin selected by user
+    //! \returns plugin selected by user
     CommonDictInterface* selectedPlugin();
 
 protected: