Penalty should be 'const int'. Note, you can set a const in the constructors init...

[user/henk/code/inspircd.git] / include / globals.h

diff --git a/include/globals.h b/include/globals.h
index bd5fdb621ac115a5967560b6491c70c5fe19f0c9..bf832be594788818ef7b0f66bc4bdc2e8ec8d5b8 100644 (file)
--- a/include/globals.h
+++ b/include/globals.h
@@ -19,9 +19,20 @@
 #include <map>
 #include <vector>
 
+/** A cached text file stored with its contents as lines
+ */
 typedef std::deque<std::string> file_cache;
+
+/** A configuration key and value pair
+ */
 typedef std::pair< std::string, std::string > KeyVal;
+
+/** A list of related configuration keys and values
+ */
 typedef std::vector< KeyVal > KeyValList;
+
+/** An entire config file, built up of KeyValLists
+ */
 typedef std::multimap< std::string, KeyValList > ConfigDataHash;
 
 #endif