Added docstrings and changed file header (license + file doc)

[mdictionary] / trunk / src / includes / settings.h

diff --git a/trunk/src/includes/settings.h b/trunk/src/includes/settings.h
index ae529f6..a6faba7 100644 (file)
--- a/trunk/src/includes/settings.h
+++ b/trunk/src/includes/settings.h
@@ -19,7 +19,11 @@
 
 *******************************************************************************/
 
-//Created by Bartosz Szatkowski
+/*! /file settings.h
+\brief Settings object for pluggins \see Settings
+
+\author Bartosz Szatkowski <bulislaw@linux.com>
+*/
 
 #ifndef SETTINGS_H
 #define SETTINGS_H
@@ -30,7 +34,11 @@
 
 class CommonDictInterface;
 
-//! Plugin specific configuration
+/*! Plugins or dictionaries may need to keep some of configuration between
+  sessions, moreover Backbone or GUI may want store some additional info in
+  plugin Settings.
+
+  Its important for plugin to store all information given it in Settings.*/
 class Settings {
   public:
     Settings(){}