Added final documentation for inspircd Beta 4

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

1 files changed, 23 insertions, 56 deletions

diff --git a/docs/module-doc/classconnection.html b/docs/module-doc/classconnection.html
index 54e5565f1..a02f27de1 100644
--- a/docs/module-doc/classconnection.html
+++ b/docs/module-doc/classconnection.html
@@ -44,9 +44,6 @@ Inherited by <a class="el" href="classserverrec.html">serverrec</a>, and <a clas
 <tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classconnection.html#a8">AddIncoming</a> (int <a class="el" href="classconnection.html#o0">fd</a>, char *targethost, int sourceport)</td></tr>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add an incoming connection to the connection pool. </em> <a href="#a8"></a><em><br><br></td></tr>
-<tr><td class="memItemLeft" nowrap align=right valign=top>long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classconnection.html#a9">GenKey</a> ()</td></tr>
-
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This function is deprecated and may be removed in a later alpha/beta. </em> <a href="#a9"></a><em><br><br></td></tr>
 <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
 <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classconnection.html#o0">fd</a></td></tr>
 
@@ -111,7 +108,7 @@ Please note: classes serverrec and userrec both inherit from class connection.
 <p>
 
 <p>
-Definition at line <a class="el" href="connection_8h-source.html#l00178">178</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
+Definition at line <a class="el" href="connection_8h-source.html#l00210">210</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
 <a name="a0" doxytag="connection::connection"></a><p>
 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
   <tr>
@@ -318,36 +315,6 @@ Find the <a class="el" href="classircd__connector.html">ircd_connector</a> oject
     </td>
   </tr>
 </table>
-<a name="a9" doxytag="connection::GenKey"></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"> long connection::GenKey </td>
-          <td class="md" valign="top">(&nbsp;</td>
-          <td class="mdname1" valign="top" nowrap>          </td>
-          <td class="md" valign="top">&nbsp;)&nbsp;</td>
-          <td class="md" nowrap></td>
-        </tr>
-
-      </table>
-    </td>
-  </tr>
-</table>
-<table cellspacing=5 cellpadding=0 border=0>
-  <tr>
-    <td>
-      &nbsp;
-    </td>
-    <td>
-
-<p>
-This function is deprecated and may be removed in a later alpha/beta. 
-<p>
-    </td>
-  </tr>
-</table>
 <a name="a3" doxytag="connection::MeshCookie"></a><p>
 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
   <tr>
@@ -535,7 +502,7 @@ Stats counter for bytes inbound.
 <p>
 
 <p>
-Definition at line <a class="el" href="connection_8h-source.html#l00199">199</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.
+Definition at line <a class="el" href="connection_8h-source.html#l00231">231</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.
 <p>
 Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec::userrec()</a>.    </td>
   </tr>
@@ -563,7 +530,7 @@ Stats counter for bytes outbound.
 <p>
 
 <p>
-Definition at line <a class="el" href="connection_8h-source.html#l00203">203</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.
+Definition at line <a class="el" href="connection_8h-source.html#l00235">235</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.
 <p>
 Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec::userrec()</a>.    </td>
   </tr>
@@ -591,7 +558,7 @@ Stats counter for commands inbound.
 <p>
 
 <p>
-Definition at line <a class="el" href="connection_8h-source.html#l00207">207</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.
+Definition at line <a class="el" href="connection_8h-source.html#l00239">239</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.
 <p>
 Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec::userrec()</a>.    </td>
   </tr>
@@ -619,7 +586,7 @@ Stats counter for commands outbound.
 <p>
 
 <p>
-Definition at line <a class="el" href="connection_8h-source.html#l00211">211</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.
+Definition at line <a class="el" href="connection_8h-source.html#l00243">243</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.
 <p>
 Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec::userrec()</a>.    </td>
   </tr>
@@ -647,7 +614,7 @@ With a serverrec, this is a list of all established server connections.
 <p>
 With a userrec this is unused.
 <p>
-Definition at line <a class="el" href="connection_8h-source.html#l00258">258</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.    </td>
+Definition at line <a class="el" href="connection_8h-source.html#l00290">290</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.    </td>
   </tr>
 </table>
 <a name="o0" doxytag="connection::fd"></a><p>
@@ -673,9 +640,9 @@ File descriptor of the connection.
 <p>
 
 <p>
-Definition at line <a class="el" href="connection_8h-source.html#l00183">183</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.
+Definition at line <a class="el" href="connection_8h-source.html#l00215">215</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.
 <p>
-Referenced by <a class="el" href="modules_8cpp-source.html#l00932">ConfigReader::DumpErrors()</a>, <a class="el" href="modules_8cpp-source.html#l00665">Server::PseudoToUser()</a>, <a class="el" href="modules_8cpp-source.html#l00522">Server::SendTo()</a>, <a class="el" href="servers_8cpp-source.html#l00026">serverrec::serverrec()</a>, <a class="el" href="users_8cpp-source.html#l00028">userrec::userrec()</a>, and <a class="el" href="modules_8cpp-source.html#l00656">Server::UserToPseudo()</a>.    </td>
+Referenced by <a class="el" href="modules_8cpp-source.html#l00948">ConfigReader::DumpErrors()</a>, <a class="el" href="modules_8cpp-source.html#l00681">Server::PseudoToUser()</a>, <a class="el" href="modules_8cpp-source.html#l00519">Server::SendTo()</a>, <a class="el" href="servers_8cpp-source.html#l00026">serverrec::serverrec()</a>, <a class="el" href="users_8cpp-source.html#l00028">userrec::userrec()</a>, and <a class="el" href="modules_8cpp-source.html#l00671">Server::UserToPseudo()</a>.    </td>
   </tr>
 </table>
 <a name="o8" doxytag="connection::haspassed"></a><p>
@@ -701,7 +668,7 @@ True if server/user has authenticated, false if otherwise.
 <p>
 
 <p>
-Definition at line <a class="el" href="connection_8h-source.html#l00215">215</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.
+Definition at line <a class="el" href="connection_8h-source.html#l00247">247</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.
 <p>
 Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec::userrec()</a>.    </td>
   </tr>
@@ -729,9 +696,9 @@ Hostname of connection.
 <p>
 Not used if this is a serverrec
 <p>
-Definition at line <a class="el" href="connection_8h-source.html#l00187">187</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.
+Definition at line <a class="el" href="connection_8h-source.html#l00219">219</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.
 <p>
-Referenced by <a class="el" href="users_8cpp-source.html#l00065">userrec::GetFullRealHost()</a>, <a class="el" href="modules_8cpp-source.html#l00665">Server::PseudoToUser()</a>, <a class="el" href="users_8cpp-source.html#l00028">userrec::userrec()</a>, and <a class="el" href="modules_8cpp-source.html#l00656">Server::UserToPseudo()</a>.    </td>
+Referenced by <a class="el" href="users_8cpp-source.html#l00068">userrec::GetFullRealHost()</a>, <a class="el" href="modules_8cpp-source.html#l00681">Server::PseudoToUser()</a>, <a class="el" href="users_8cpp-source.html#l00028">userrec::userrec()</a>, and <a class="el" href="modules_8cpp-source.html#l00671">Server::UserToPseudo()</a>.    </td>
   </tr>
 </table>
 <a name="o14" doxytag="connection::idle_lastmsg"></a><p>
@@ -757,7 +724,7 @@ Time that the connection last sent data, used to calculate idle time.
 <p>
 
 <p>
-Definition at line <a class="el" href="connection_8h-source.html#l00241">241</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.
+Definition at line <a class="el" href="connection_8h-source.html#l00273">273</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.
 <p>
 Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec::userrec()</a>.    </td>
   </tr>
@@ -785,7 +752,7 @@ Inbuf of connection.
 <p>
 Only used for userrec
 <p>
-Definition at line <a class="el" href="connection_8h-source.html#l00195">195</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.
+Definition at line <a class="el" href="connection_8h-source.html#l00227">227</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.
 <p>
 Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec::userrec()</a>.    </td>
   </tr>
@@ -813,7 +780,7 @@ Unused, will be removed in a future alpha/beta.
 <p>
 
 <p>
-Definition at line <a class="el" href="connection_8h-source.html#l00249">249</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.    </td>
+Definition at line <a class="el" href="connection_8h-source.html#l00281">281</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.    </td>
   </tr>
 </table>
 <a name="o17" doxytag="connection::internal_port"></a><p>
@@ -839,7 +806,7 @@ Unused, will be removed in a future alpha/beta.
 <p>
 
 <p>
-Definition at line <a class="el" href="connection_8h-source.html#l00253">253</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.    </td>
+Definition at line <a class="el" href="connection_8h-source.html#l00285">285</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.    </td>
   </tr>
 </table>
 <a name="o2" doxytag="connection::ip"></a><p>
@@ -865,7 +832,7 @@ IP of connection.
 <p>
 Reserved for future use.
 <p>
-Definition at line <a class="el" href="connection_8h-source.html#l00191">191</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.
+Definition at line <a class="el" href="connection_8h-source.html#l00223">223</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.
 <p>
 Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec::userrec()</a>.    </td>
   </tr>
@@ -893,7 +860,7 @@ Time the connection was last pinged.
 <p>
 
 <p>
-Definition at line <a class="el" href="connection_8h-source.html#l00233">233</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.
+Definition at line <a class="el" href="connection_8h-source.html#l00265">265</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.
 <p>
 Referenced by <a class="el" href="servers_8cpp-source.html#l00026">serverrec::serverrec()</a>, and <a class="el" href="users_8cpp-source.html#l00028">userrec::userrec()</a>.    </td>
   </tr>
@@ -921,7 +888,7 @@ Used by PING checks with clients.
 <p>
 
 <p>
-Definition at line <a class="el" href="connection_8h-source.html#l00245">245</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.
+Definition at line <a class="el" href="connection_8h-source.html#l00277">277</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.
 <p>
 Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec::userrec()</a>.    </td>
   </tr>
@@ -949,7 +916,7 @@ Port number For a userrec, this is the port they connected to the network on.
 <p>
 For a serverrec this is the current listening port of the serverrec object.
 <p>
-Definition at line <a class="el" href="connection_8h-source.html#l00221">221</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.
+Definition at line <a class="el" href="connection_8h-source.html#l00253">253</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.
 <p>
 Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec::userrec()</a>.    </td>
   </tr>
@@ -977,7 +944,7 @@ Used by userrec to indicate the registration status of the connection.
 <p>
 
 <p>
-Definition at line <a class="el" href="connection_8h-source.html#l00225">225</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.
+Definition at line <a class="el" href="connection_8h-source.html#l00257">257</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.
 <p>
 Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec::userrec()</a>.    </td>
   </tr>
@@ -1005,7 +972,7 @@ Time the connection was created, set in the constructor.
 <p>
 
 <p>
-Definition at line <a class="el" href="connection_8h-source.html#l00237">237</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.
+Definition at line <a class="el" href="connection_8h-source.html#l00269">269</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.
 <p>
 Referenced by <a class="el" href="servers_8cpp-source.html#l00026">serverrec::serverrec()</a>, and <a class="el" href="users_8cpp-source.html#l00028">userrec::userrec()</a>.    </td>
   </tr>
@@ -1033,12 +1000,12 @@ Reserved for future use.
 <p>
 
 <p>
-Definition at line <a class="el" href="connection_8h-source.html#l00229">229</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.    </td>
+Definition at line <a class="el" href="connection_8h-source.html#l00261">261</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.    </td>
   </tr>
 </table>
 <hr>The documentation for this class was generated from the following file:<ul>
 <li><a class="el" href="connection_8h-source.html">connection.h</a></ul>
-<hr size="1"><address style="align: right;"><small>Generated on Tue Apr 26 17:11:47 2005 for InspIRCd by
+<hr size="1"><address style="align: right;"><small>Generated on Sat May 7 15:34:24 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>