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

2 files changed, 72 insertions, 0 deletions

diff --git a/docs/man/man3/irc_InAddr_HashComp.3 b/docs/man/man3/irc_InAddr_HashComp.3
new file mode 100644
index 000000000..5127b013b
--- /dev/null
+++ b/docs/man/man3/irc_InAddr_HashComp.3
@@ -0,0 +1,36 @@
+.TH "irc::InAddr_HashComp" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*-
+.ad l
+.nh
+.SH NAME
+irc::InAddr_HashComp \- This class returns true if two in_addr structs match.  
+
+.PP
+.SH SYNOPSIS
+.br
+.PP
+\fC#include <hashcomp.h>\fP
+.PP
+.SS "Public Member Functions"
+
+.in +1c
+.ti -1c
+.RI "bool \fBoperator()\fP (const in_addr &s1, const in_addr &s2) const"
+.br
+.RI "\fIThe operator () does the actual comparison in hash_map. \fP"
+.in -1c
+.SH "Detailed Description"
+.PP 
+This class returns true if two in_addr structs match. 
+
+Checking is done by copying both into a size_t then doing a numeric comparison of the two.
+.PP
+Definition at line 77 of file hashcomp.h.
+.SH "Member Function Documentation"
+.PP 
+.SS "bool irc::InAddr_HashComp::operator() (const in_addr & s1, const in_addr & s2) const"
+.PP
+The operator () does the actual comparison in hash_map. 
+
+.SH "Author"
+.PP 
+Generated automatically by Doxygen for InspIRCd from the source code.
diff --git a/docs/man/man3/irc_StrHashComp.3 b/docs/man/man3/irc_StrHashComp.3
new file mode 100644
index 000000000..a6b8036e1
--- /dev/null
+++ b/docs/man/man3/irc_StrHashComp.3
@@ -0,0 +1,36 @@
+.TH "irc::StrHashComp" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*-
+.ad l
+.nh
+.SH NAME
+irc::StrHashComp \- This class returns true if two strings match.  
+
+.PP
+.SH SYNOPSIS
+.br
+.PP
+\fC#include <hashcomp.h>\fP
+.PP
+.SS "Public Member Functions"
+
+.in +1c
+.ti -1c
+.RI "bool \fBoperator()\fP (const std::string &s1, const std::string &s2) const"
+.br
+.RI "\fIThe operator () does the actual comparison in hash_map. \fP"
+.in -1c
+.SH "Detailed Description"
+.PP 
+This class returns true if two strings match. 
+
+Case sensitivity is ignored, and the RFC 'character set' is adhered to
+.PP
+Definition at line 65 of file hashcomp.h.
+.SH "Member Function Documentation"
+.PP 
+.SS "bool irc::StrHashComp::operator() (const std::string & s1, const std::string & s2) const"
+.PP
+The operator () does the actual comparison in hash_map. 
+
+.SH "Author"
+.PP 
+Generated automatically by Doxygen for InspIRCd from the source code.