Added docs for hashcomp

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

1 files changed, 66 insertions, 0 deletions

diff --git a/docs/man/man3/irc_irc_char_traits.3 b/docs/man/man3/irc_irc_char_traits.3
new file mode 100644
index 000000000..1ee931ba6
--- /dev/null
+++ b/docs/man/man3/irc_irc_char_traits.3
@@ -0,0 +1,66 @@
+.TH "irc::irc_char_traits" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*-
+.ad l
+.nh
+.SH NAME
+irc::irc_char_traits \- The \fBirc_char_traits\fP class is used for RFC-style comparison of strings.  
+
+.PP
+.SH SYNOPSIS
+.br
+.PP
+\fC#include <hashcomp.h>\fP
+.PP
+Inherits \fBchar_traits< char >\fP.
+.PP
+.SS "Static Public Member Functions"
+
+.in +1c
+.ti -1c
+.RI "bool \fBeq\fP (char c1st, char c2nd)"
+.br
+.RI "\fICheck if two chars match. \fP"
+.ti -1c
+.RI "bool \fBne\fP (char c1st, char c2nd)"
+.br
+.RI "\fICheck if two chars do NOT match. \fP"
+.ti -1c
+.RI "bool \fBlt\fP (char c1st, char c2nd)"
+.br
+.RI "\fICheck if one char is less than another. \fP"
+.ti -1c
+.RI "int \fBcompare\fP (const char *str1, const char *str2, size_t n)"
+.br
+.RI "\fICompare two strings of size n. \fP"
+.ti -1c
+.RI "const char * \fBfind\fP (const char *s1, int n, char c)"
+.br
+.RI "\fIFind a char within a string up to position n. \fP"
+.in -1c
+.SH "Detailed Description"
+.PP 
+The \fBirc_char_traits\fP class is used for RFC-style comparison of strings. 
+
+This class is used to implement \fBirc::string\fP, a case-insensitive, RFC- comparing string class.
+.PP
+Definition at line 86 of file hashcomp.h.
+.SH "Member Function Documentation"
+.PP 
+.SS "int irc::irc_char_traits::compare (const char * str1, const char * str2, size_t n)\fC [static]\fP"
+.PP
+Compare two strings of size n. 
+.SS "bool irc::irc_char_traits::eq (char c1st, char c2nd)\fC [static]\fP"
+.PP
+Check if two chars match. 
+.SS "const char* irc::irc_char_traits::find (const char * s1, int n, char c)\fC [static]\fP"
+.PP
+Find a char within a string up to position n. 
+.SS "bool irc::irc_char_traits::lt (char c1st, char c2nd)\fC [static]\fP"
+.PP
+Check if one char is less than another. 
+.SS "bool irc::irc_char_traits::ne (char c1st, char c2nd)\fC [static]\fP"
+.PP
+Check if two chars do NOT match. 
+
+.SH "Author"
+.PP 
+Generated automatically by Doxygen for InspIRCd from the source code.