Add call to protocol interface to get useful info on the server map. Return a std...

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

diff --git a/include/globals.h b/include/globals.h
index 6435b5813a592d7d22be97e9c88818e2db44fbd2..2de2ba11bcd2f248950f60f334d869c3be0fa5d8 100644 (file)
--- a/include/globals.h
+++ b/include/globals.h
@@ -2,12 +2,9 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- *                       E-mail:
- *                <brain@chatspike.net>
- *                <Craig@chatspike.net>
- *     
- * Written by Craig Edwards, Craig McLure, and others.
+ *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
+ *
  * This program is free but copyrighted software; see
  *            the file COPYING for details.
  *
@@ -17,13 +14,24 @@
 #ifndef __WORLD_H
 #define __WORLD_H
 
-#include <string>
+#include <vector>
 #include <deque>
 #include <map>
 
-typedef std::deque<std::string> file_cache;
+/** 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