Added new documentation to cover ircd_connector

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

1 files changed, 56 insertions, 15 deletions

diff --git a/docs/module-doc/classConnectClass.html b/docs/module-doc/classConnectClass.html
index 412d670b5..fd3af8430 100644
--- a/docs/module-doc/classConnectClass.html
+++ b/docs/module-doc/classConnectClass.html
@@ -25,9 +25,15 @@ Inheritance diagram for ConnectClass:<p><center><img src="classConnectClass__inh
 <tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classConnectClass.html#a0">ConnectClass</a> ()</td></tr>
 <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
 <tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classConnectClass.html#m0">type</a></td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Type of line, either CC_ALLOW or CC_DENY.</em> <a href="#m0"></a><em></em></font><br><br></td></tr>
 <tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classConnectClass.html#m1">registration_timeout</a></td></tr>
-<tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="classConnectClass.html#m2">host</a> [MAXBUF]</td></tr>
-<tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="classConnectClass.html#m3">pass</a> [MAXBUF]</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Max time to register the connection in seconds.</em> <a href="#m1"></a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classConnectClass.html#m2">flood</a></td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Number of lines in buffer before excess flood is triggered.</em> <a href="#m2"></a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="classConnectClass.html#m3">host</a> [MAXBUF]</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Host mask for this line.</em> <a href="#m3"></a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="classConnectClass.html#m4">pass</a> [MAXBUF]</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>(Optional) Password for this line</em> <a href="#m4"></a><em></em></font><br><br></td></tr>
 </table>
 <hr><a name="_details"></a><h2>Detailed Description</h2>
 Holds information relevent to &lt;connect allow&gt; and &lt;connect deny&gt; tags in the config file.
@@ -62,18 +68,45 @@ Definition at line <a class="el" href="users_8h-source.html#l00034">34</a> of fi
 <p>
 
 <p>
-Definition at line <a class="el" href="users_8h-source.html#l00042">42</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
+Definition at line <a class="el" href="users_8h-source.html#l00053">53</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
 <p>
-<div class="fragment"><pre>00043         {
-00044                 <a class="code" href="classConnectClass.html#m1">registration_timeout</a> = 0;
-00045                 strcpy(host,<span class="stringliteral">""</span>);
-00046                 strcpy(pass,<span class="stringliteral">""</span>);
-00047         }
+<div class="fragment"><pre>00054         {
+00055                 <a class="code" href="classConnectClass.html#m1">registration_timeout</a> = 0;
+00056                 <a class="code" href="classConnectClass.html#m2">flood</a> = 0;
+00057                 strcpy(host,<span class="stringliteral">""</span>);
+00058                 strcpy(pass,<span class="stringliteral">""</span>);
+00059         }
 </pre></div>    </td>
   </tr>
 </table>
 <hr><h2>Member Data Documentation</h2>
-<a name="m2" doxytag="ConnectClass::host"></a><p>
+<a name="m2" doxytag="ConnectClass::flood"></a><p>
+<table width="100%" cellpadding="2" cellspacing="0" border="0">
+  <tr>
+    <td class="md">
+      <table cellpadding="0" cellspacing="0" border="0">
+        <tr>
+          <td class="md" nowrap valign="top"> int ConnectClass::flood
+      </table>
+    </td>
+  </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+  <tr>
+    <td>
+      &nbsp;
+    </td>
+    <td>
+
+<p>
+Number of lines in buffer before excess flood is triggered.
+<p>
+
+<p>
+Definition at line <a class="el" href="users_8h-source.html#l00045">45</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
+  </tr>
+</table>
+<a name="m3" doxytag="ConnectClass::host"></a><p>
 <table width="100%" cellpadding="2" cellspacing="0" border="0">
   <tr>
     <td class="md">
@@ -92,12 +125,14 @@ Definition at line <a class="el" href="users_8h-source.html#l00042">42</a> of fi
     <td>
 
 <p>
+Host mask for this line.
+<p>
 
 <p>
-Definition at line <a class="el" href="users_8h-source.html#l00039">39</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
+Definition at line <a class="el" href="users_8h-source.html#l00048">48</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
   </tr>
 </table>
-<a name="m3" doxytag="ConnectClass::pass"></a><p>
+<a name="m4" doxytag="ConnectClass::pass"></a><p>
 <table width="100%" cellpadding="2" cellspacing="0" border="0">
   <tr>
     <td class="md">
@@ -116,9 +151,11 @@ Definition at line <a class="el" href="users_8h-source.html#l00039">39</a> of fi
     <td>
 
 <p>
+(Optional) Password for this line
+<p>
 
 <p>
-Definition at line <a class="el" href="users_8h-source.html#l00040">40</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
+Definition at line <a class="el" href="users_8h-source.html#l00051">51</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
   </tr>
 </table>
 <a name="m1" doxytag="ConnectClass::registration_timeout"></a><p>
@@ -140,9 +177,11 @@ Definition at line <a class="el" href="users_8h-source.html#l00040">40</a> of fi
     <td>
 
 <p>
+Max time to register the connection in seconds.
+<p>
 
 <p>
-Definition at line <a class="el" href="users_8h-source.html#l00038">38</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
+Definition at line <a class="el" href="users_8h-source.html#l00042">42</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
   </tr>
 </table>
 <a name="m0" doxytag="ConnectClass::type"></a><p>
@@ -164,14 +203,16 @@ Definition at line <a class="el" href="users_8h-source.html#l00038">38</a> of fi
     <td>
 
 <p>
+Type of line, either CC_ALLOW or CC_DENY.
+<p>
 
 <p>
-Definition at line <a class="el" href="users_8h-source.html#l00037">37</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
+Definition at line <a class="el" href="users_8h-source.html#l00039">39</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
   </tr>
 </table>
 <hr>The documentation for this class was generated from the following file:<ul>
 <li><a class="el" href="users_8h-source.html">users.h</a></ul>
-<hr><address style="align: right;"><small>Generated on Thu Apr 8 19:12:57 2004 for InspIRCd by
+<hr><address style="align: right;"><small>Generated on Sat Apr 17 13:31:48 2004 for InspIRCd by
 <a href="http://www.doxygen.org/index.html">
 <img src="doxygen.png" alt="doxygen" align="middle" border=0 
 width=110 height=53></a>1.3-rc3 </small></address>