From 7455e1c881f12eaf3ec9658ac84add6b61b131a3 Mon Sep 17 00:00:00 2001
From: brain
Date: Sun, 30 Mar 2003 18:38:07 +0000
Subject: Updated docs

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@171 e03df62e-2008-0410-955e-edbf42e46eb7
---
 docs/module-doc/classModule.html | 22 +++++++++++++++++-----
 1 file changed, 17 insertions(+), 5 deletions(-)

(limited to 'docs/module-doc/classModule.html')

diff --git a/docs/module-doc/classModule.html b/docs/module-doc/classModule.html
index b15439b3d..7fd4956d7 100644
--- a/docs/module-doc/classModule.html
+++ b/docs/module-doc/classModule.html
@@ -37,9 +37,13 @@ Inheritance diagram for Module:<p><center><img src="classModule__inherit__graph.
 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classModule.html#a6">OnUserPart</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *channel)</td></tr>
 <tr><td>&nbsp;</td><td><font size=-1><em>Called when a user parts a channel.</em> <a href="#a6"></a><em></em></font><br><br></td></tr>
 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classModule.html#a7">Module::OnPacketTransmit</a> (char *p)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Called before a packet is transmitted across the irc network between two irc servers.</em> <a href="#a7"></a><em></em></font><br><br></td></tr>
 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classModule.html#a8">Module::OnPacketReceive</a> (char *p)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Called after a packet is received from another irc server.</em> <a href="#a8"></a><em></em></font><br><br></td></tr>
 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classModule.html#a9">OnRehash</a> ()</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Called on rehash.</em> <a href="#a9"></a><em></em></font><br><br></td></tr>
 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classModule.html#a10">Module::OnServerRaw</a> (string &amp;raw, bool inbound)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Called when a raw command is transmitted or received.</em> <a href="#a10"></a><em></em></font><br><br></td></tr>
 </table>
 <hr><a name="_details"></a><h2>Detailed Description</h2>
 Base class for all InspIRCd modules This class is the base class for InspIRCd modules.
@@ -181,7 +185,9 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00037">37</a> o
     <td>
 
 <p>
-    </td>
+Called after a packet is received from another irc server.
+<p>
+The packet is represented as a char*, as it should be regarded as a buffer, and not a string. This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called immediately after the packet is received but before any other operations with the core of the ircd.    </td>
   </tr>
 </table>
 <a name="a7" doxytag="Module::Module::OnPacketTransmit"></a><p>
@@ -210,7 +216,9 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00037">37</a> o
     <td>
 
 <p>
-    </td>
+Called before a packet is transmitted across the irc network between two irc servers.
+<p>
+The packet is represented as a char*, as it should be regarded as a buffer, and not a string. This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called before ANY other operations within the ircd core program.    </td>
   </tr>
 </table>
 <a name="a10" doxytag="Module::Module::OnServerRaw"></a><p>
@@ -248,7 +256,9 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00037">37</a> o
     <td>
 
 <p>
-    </td>
+Called when a raw command is transmitted or received.
+<p>
+This method is the lowest level of handler available to a module. It will be called with raw data which is passing through a connected socket. If you wish, you may munge this data by changing the string parameter "raw". If you do this, after your function exits it will immediately be cut down to 510 characters plus a carriage return and linefeed.    </td>
   </tr>
 </table>
 <a name="a9" doxytag="Module::OnRehash"></a><p>
@@ -276,7 +286,9 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00037">37</a> o
     <td>
 
 <p>
-
+Called on rehash.
+<p>
+This method is called prior to a /REHASH or when a SIGHUP is received from the operating system. You should use it to reload any files so that your module keeps in step with the rest of the application.
 <p>
 Definition at line <a class="el" href="modules_8cpp-source.html#l00035">35</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
 <p>
@@ -448,7 +460,7 @@ Definition at line <a class="el" href="modules_8cpp-source.html#l00030">30</a> o
 </table>
 <hr>The documentation for this class was generated from the following files:<ul>
 <li><a class="el" href="modules_8h-source.html">modules.h</a><li><a class="el" href="modules_8cpp-source.html">modules.cpp</a></ul>
-<hr><address style="align: right;"><small>Generated on Sun Mar 30 13:29:10 2003 for InspIRCd by
+<hr><address style="align: right;"><small>Generated on Sun Mar 30 19:36:13 2003 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>
-- 
cgit v1.3.1-10-gc9f91