Updated to keep lowermap const within hashcomp.cpp

Updated docs


git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1401 e03df62e-2008-0410-955e-edbf42e46eb7

1 files changed, 9 insertions, 5 deletions

diff --git a/include/hashcomp.h b/include/hashcomp.h
index 32d155e30..a9bf15ab9 100644
--- a/include/hashcomp.h
+++ b/include/hashcomp.h
@@ -19,16 +19,20 @@
 
 #include "inspircd_config.h"
 
-/**
+/*******************************************************
  * This file contains classes and templates that deal
  * with the comparison and hashing of 'irc strings'.
  * An 'irc string' is a string which compares in a
  * case insensitive manner, and as per RFC 1459 will
  * treat [ identical to {, ] identical to }, and \
- * as identical to |. Our hashing functions are designed
- * to accept std::string and compare/hash them in an irc
- * type way, irc::string is a seperate class type currently.
- */
+ * as identical to |.
+ *
+ * Our hashing functions are designed  to accept
+ * std::string and compare/hash them as type irc::string
+ * by converting them internally. This makes them
+ * backwards compatible with other code which is not
+ * aware of irc::string.
+ *******************************************************/
 
 #ifdef GCC3
 #include <ext/hash_map>