Comments (lots of)

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

diff --git a/include/globals.h b/include/globals.h
index d30f18edea57dffd095b0bd20b464be90724404a..4a01e454eed81eef909734d8f9b0c99a36708bc1 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-2007 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,20 +14,26 @@
 #ifndef __WORLD_H
 #define __WORLD_H
 
-// include the common header files
-
-#include <typeinfo>
-#include <iostream>
 #include <string>
 #include <deque>
-#include "users.h"
-#include "channels.h"
+#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;
-typedef std::multimap< std::string, KeyValList > ConfigDataHash;
 
-int isnick(const char *n);
+/** An entire config file, built up of KeyValLists
+ */
+typedef std::multimap< std::string, KeyValList > ConfigDataHash;
 
 #endif
+