Added comments to Configuration class
authorGuilherme Maciel Ferreira <guilherme.maciel.ferreira@gmail.com>
Tue, 13 Sep 2011 02:09:45 +0000 (23:09 -0300)
committerGuilherme Maciel Ferreira <guilherme.maciel.ferreira@gmail.com>
Tue, 13 Sep 2011 02:09:45 +0000 (23:09 -0300)
src/config/configuration.h

index 190fe53..1c2fd34 100644 (file)
@@ -33,6 +33,9 @@ on this file might be covered by the GNU General Public License.
 // Configuration
 //-----------------------------------------------------------------------------
 
+/**
+ * @brief This class works like a POD (Plain Old Data) for configuration options.
+ */
 class Configuration
 {
 public:
@@ -97,4 +100,4 @@ private:
 
 typedef boost::shared_ptr<Configuration> ConfigurationItem;
 
-#endif /* CONFIGURATION_H */
+#endif // CONFIGURATION_H