Updated comments

[mdictionary] / trunk / src / base / gui / SettingsWidget.h

diff --git a/trunk/src/base/gui/SettingsWidget.h b/trunk/src/base/gui/SettingsWidget.h
index defb521..f7ed38d 100644 (file)
--- a/trunk/src/base/gui/SettingsWidget.h
+++ b/trunk/src/base/gui/SettingsWidget.h
@@ -19,7 +19,9 @@
 
 *******************************************************************************/
 
-//Created by Mateusz Półrola
+//! \file DictManagerWidget.h
+//! \brief Settings widget
+//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
 
 #ifndef SETTINGSWIDGET_H
 #define SETTINGSWIDGET_H
@@ -29,10 +31,24 @@
 #include "../../includes/GUIInterface.h"
 #include "../../includes/settings.h"
 
+//! Implements applications settings widget
+/*!
+  Shows settings that user can change.
+  It allow to change limit of searches and limit of history.
+  Also it allow to select if application have to search in dictionaries or in
+  bookmarks or in both of them. All changes are saved automatically after
+  hiding of this widget.
+  */
 class SettingsWidget : public QDialog
 {
     Q_OBJECT
 public:
+    //! Constructor
+    /*!
+      \param parent parent of this widget, which must be subclass of
+      GUIInterface, because it will use it to get current settings and
+      sets new ones.
+      */
     explicit SettingsWidget(GUIInterface *parent = 0);
 
 protected: