Added docs for hashcomp

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1396 e03df62e-2008-0410-955e-edbf42e46eb7
author: brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> 2005-05-15 17:05:15 +0000
committer: brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> 2005-05-15 17:05:15 +0000
commit: 4d5a17380bc71cabe544b41c7c8a26a292384f3d (patch)
tree: 9a882bc421d4c250817a17980265b76e06e4cf8c /docs/module-doc/structirc_1_1irc__char__traits.html
parent: a48ee868ed80b689b773fdd9bbd8f1e761dc3b8a (diff)
1 files changed, 267 insertions, 0 deletions
diff --git a/docs/module-doc/structirc_1_1irc__char__traits.html b/docs/module-doc/structirc_1_1irc__char__traits.html
new file mode 100644
index 000000000..6953a5bdd
--- /dev/null
+++ b/docs/module-doc/structirc_1_1irc__char__traits.html
@@ -0,0 +1,267 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
+<title>InspIRCd: irc::irc_char_traits struct Reference</title>
+<link href="inspircd.doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.3.3 -->
+<div class="qindex"><a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Compound&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Compound&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
+<h1>irc::irc_char_traits Struct Reference</h1>The <a class="el" href="structirc_1_1irc__char__traits.html">irc_char_traits</a> class is used for RFC-style comparison of strings.  
+<a href="#_details">More...</a>
+<p>
+<code>#include &lt;<a class="el" href="hashcomp_8h-source.html">hashcomp.h</a>&gt;</code>
+<p>
+Inheritance diagram for irc::irc_char_traits:<p><center><img src="structirc_1_1irc__char__traits__inherit__graph.gif" border="0" usemap="#irc_1_1irc__char__traits__inherit__map" alt="Inheritance graph"></center>
+<map name="irc_1_1irc__char__traits__inherit__map">
+<area href="classstd_1_1char__traits.html" shape="rect" coords="8,7,160,34" alt="">
+</map>
+<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for irc::irc_char_traits:<p><center><img src="structirc_1_1irc__char__traits__coll__graph.gif" border="0" usemap="#irc_1_1irc__char__traits__coll__map" alt="Collaboration graph"></center>
+<map name="irc_1_1irc__char__traits__coll__map">
+<area href="classstd_1_1char__traits.html" shape="rect" coords="8,7,160,34" alt="">
+</map>
+<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="structirc_1_1irc__char__traits-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
+<tr><td></td></tr>
+<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structirc_1_1irc__char__traits.html#e0">eq</a> (char c1st, char c2nd)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Check if two chars match. </em> <a href="#e0"></a><em><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structirc_1_1irc__char__traits.html#e1">ne</a> (char c1st, char c2nd)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Check if two chars do NOT match. </em> <a href="#e1"></a><em><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structirc_1_1irc__char__traits.html#e2">lt</a> (char c1st, char c2nd)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Check if one char is less than another. </em> <a href="#e2"></a><em><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structirc_1_1irc__char__traits.html#e3">compare</a> (const char *str1, const char *str2, size_t n)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compare two strings of size n. </em> <a href="#e3"></a><em><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>const char *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structirc_1_1irc__char__traits.html#e4">find</a> (const char *s1, int n, char c)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Find a char within a string up to position n. </em> <a href="#e4"></a><em><br><br></td></tr>
+</table>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+The <a class="el" href="structirc_1_1irc__char__traits.html">irc_char_traits</a> class is used for RFC-style comparison of strings. 
+<p>
+This class is used to implement <a class="el" href="namespaceirc.html#a0">irc::string</a>, a case-insensitive, RFC- comparing string class.
+<p>
+
+<p>
+Definition at line <a class="el" href="hashcomp_8h-source.html#l00086">86</a> of file <a class="el" href="hashcomp_8h-source.html">hashcomp.h</a>.<hr><h2>Member Function Documentation</h2>
+<a name="e3" doxytag="irc::irc_char_traits::compare"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+  <tr>
+    <td class="mdRow">
+      <table cellpadding="0" cellspacing="0" border="0">
+        <tr>
+          <td class="md" nowrap valign="top"> int irc::irc_char_traits::compare </td>
+          <td class="md" valign="top">(&nbsp;</td>
+          <td class="md" nowrap valign="top">const char *&nbsp;</td>
+          <td class="mdname" nowrap> <em>str1</em>, </td>
+        </tr>
+        <tr>
+          <td></td>
+          <td></td>
+          <td class="md" nowrap>const char *&nbsp;</td>
+          <td class="mdname" nowrap> <em>str2</em>, </td>
+        </tr>
+        <tr>
+          <td></td>
+          <td></td>
+          <td class="md" nowrap>size_t&nbsp;</td>
+          <td class="mdname" nowrap> <em>n</em></td>
+        </tr>
+        <tr>
+          <td></td>
+          <td class="md">)&nbsp;</td>
+          <td class="md" colspan="2"><code> [static]</code></td>
+        </tr>
+
+      </table>
+    </td>
+  </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+  <tr>
+    <td>
+      &nbsp;
+    </td>
+    <td>
+
+<p>
+Compare two strings of size n. 
+<p>
+    </td>
+  </tr>
+</table>
+<a name="e0" doxytag="irc::irc_char_traits::eq"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+  <tr>
+    <td class="mdRow">
+      <table cellpadding="0" cellspacing="0" border="0">
+        <tr>
+          <td class="md" nowrap valign="top"> bool irc::irc_char_traits::eq </td>
+          <td class="md" valign="top">(&nbsp;</td>
+          <td class="md" nowrap valign="top">char&nbsp;</td>
+          <td class="mdname" nowrap> <em>c1st</em>, </td>
+        </tr>
+        <tr>
+          <td></td>
+          <td></td>
+          <td class="md" nowrap>char&nbsp;</td>
+          <td class="mdname" nowrap> <em>c2nd</em></td>
+        </tr>
+        <tr>
+          <td></td>
+          <td class="md">)&nbsp;</td>
+          <td class="md" colspan="2"><code> [static]</code></td>
+        </tr>
+
+      </table>
+    </td>
+  </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+  <tr>
+    <td>
+      &nbsp;
+    </td>
+    <td>
+
+<p>
+Check if two chars match. 
+<p>
+    </td>
+  </tr>
+</table>
+<a name="e4" doxytag="irc::irc_char_traits::find"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+  <tr>
+    <td class="mdRow">
+      <table cellpadding="0" cellspacing="0" border="0">
+        <tr>
+          <td class="md" nowrap valign="top"> const char* irc::irc_char_traits::find </td>
+          <td class="md" valign="top">(&nbsp;</td>
+          <td class="md" nowrap valign="top">const char *&nbsp;</td>
+          <td class="mdname" nowrap> <em>s1</em>, </td>
+        </tr>
+        <tr>
+          <td></td>
+          <td></td>
+          <td class="md" nowrap>int&nbsp;</td>
+          <td class="mdname" nowrap> <em>n</em>, </td>
+        </tr>
+        <tr>
+          <td></td>
+          <td></td>
+          <td class="md" nowrap>char&nbsp;</td>
+          <td class="mdname" nowrap> <em>c</em></td>
+        </tr>
+        <tr>
+          <td></td>
+          <td class="md">)&nbsp;</td>
+          <td class="md" colspan="2"><code> [static]</code></td>
+        </tr>
+
+      </table>
+    </td>
+  </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+  <tr>
+    <td>
+      &nbsp;
+    </td>
+    <td>
+
+<p>
+Find a char within a string up to position n. 
+<p>
+    </td>
+  </tr>
+</table>
+<a name="e2" doxytag="irc::irc_char_traits::lt"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+  <tr>
+    <td class="mdRow">
+      <table cellpadding="0" cellspacing="0" border="0">
+        <tr>
+          <td class="md" nowrap valign="top"> bool irc::irc_char_traits::lt </td>
+          <td class="md" valign="top">(&nbsp;</td>
+          <td class="md" nowrap valign="top">char&nbsp;</td>
+          <td class="mdname" nowrap> <em>c1st</em>, </td>
+        </tr>
+        <tr>
+          <td></td>
+          <td></td>
+          <td class="md" nowrap>char&nbsp;</td>
+          <td class="mdname" nowrap> <em>c2nd</em></td>
+        </tr>
+        <tr>
+          <td></td>
+          <td class="md">)&nbsp;</td>
+          <td class="md" colspan="2"><code> [static]</code></td>
+        </tr>
+
+      </table>
+    </td>
+  </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+  <tr>
+    <td>
+      &nbsp;
+    </td>
+    <td>
+
+<p>
+Check if one char is less than another. 
+<p>
+    </td>
+  </tr>
+</table>
+<a name="e1" doxytag="irc::irc_char_traits::ne"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+  <tr>
+    <td class="mdRow">
+      <table cellpadding="0" cellspacing="0" border="0">
+        <tr>
+          <td class="md" nowrap valign="top"> bool irc::irc_char_traits::ne </td>
+          <td class="md" valign="top">(&nbsp;</td>
+          <td class="md" nowrap valign="top">char&nbsp;</td>
+          <td class="mdname" nowrap> <em>c1st</em>, </td>
+        </tr>
+        <tr>
+          <td></td>
+          <td></td>
+          <td class="md" nowrap>char&nbsp;</td>
+          <td class="mdname" nowrap> <em>c2nd</em></td>
+        </tr>
+        <tr>
+          <td></td>
+          <td class="md">)&nbsp;</td>
+          <td class="md" colspan="2"><code> [static]</code></td>
+        </tr>
+
+      </table>
+    </td>
+  </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+  <tr>
+    <td>
+      &nbsp;
+    </td>
+    <td>
+
+<p>
+Check if two chars do NOT match. 
+<p>
+    </td>
+  </tr>
+</table>
+<hr>The documentation for this struct was generated from the following file:<ul>
+<li><a class="el" href="hashcomp_8h-source.html">hashcomp.h</a></ul>
+<hr size="1"><address style="align: right;"><small>Generated on Sun May 15 17:03:56 2005 for InspIRCd by
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border=0 > 
+</a>1.3.3 </small></address>
+</body>
+</html>
author	brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>	2005-05-15 17:05:15 +0000
committer	brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>	2005-05-15 17:05:15 +0000
commit	4d5a17380bc71cabe544b41c7c8a26a292384f3d (patch)
tree	9a882bc421d4c250817a17980265b76e06e4cf8c /docs/module-doc/structirc_1_1irc__char__traits.html
parent	a48ee868ed80b689b773fdd9bbd8f1e761dc3b8a (diff)