diff options
| author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2004-04-04 22:03:32 +0000 |
|---|---|---|
| committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2004-04-04 22:03:32 +0000 |
| commit | 78a96055c428d1970ece93dfb01902ac0d1699bd (patch) | |
| tree | b0df96bae212f97c67ebf2339d40454f2283e5d3 /docs/module-doc/classModule.html | |
| parent | db6ed68db7e38e21a9ce66cecaf42006f034dc62 (diff) | |
New documentation to document user/channel mode handling
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@380 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/module-doc/classModule.html')
| -rw-r--r-- | docs/module-doc/classModule.html | 52 |
1 files changed, 26 insertions, 26 deletions
diff --git a/docs/module-doc/classModule.html b/docs/module-doc/classModule.html index 2a212a72e..3f7a50405 100644 --- a/docs/module-doc/classModule.html +++ b/docs/module-doc/classModule.html @@ -5,7 +5,7 @@ </head><body> <!-- Generated by Doxygen 1.3-rc3 --> <center> -<a class="qindex" href="main.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center> +<a class="qindex" href="main.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center> <hr><h1>Module Class Reference</h1>Base class for all InspIRCd modules This class is the base class for InspIRCd modules. <a href="#_details">More...</a> <p> @@ -86,9 +86,9 @@ Default constructor creates a module class. <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00093">93</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00107">107</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00093 { } +<div class="fragment"><pre>00107 { } </pre></div> </td> </tr> </table> @@ -121,9 +121,9 @@ Default destructor destroys a module class. <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00094">94</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00108">108</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00094 { } +<div class="fragment"><pre>00108 { } </pre></div> </td> </tr> </table> @@ -157,9 +157,9 @@ Returns the version number of a Module. <p> The method should return a <a class="el" href="classVersion.html">Version</a> object with its version information assigned via <a class="el" href="classVersion.html#a0">Version::Version</a> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00105">105</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00119">119</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00105 { <span class="keywordflow">return</span> <a class="code" href="classVersion.html">Version</a>(1,0,0,0); } +<div class="fragment"><pre>00119 { <span class="keywordflow">return</span> <a class="code" href="classVersion.html">Version</a>(1,0,0,0); } </pre></div> </td> </tr> </table> @@ -274,9 +274,9 @@ Called whenever an extended mode is to be processed. <p> The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being changed. mode_on is set when the mode is being set, in which case params contains a list of parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters may contain the parameters for the mode, dependent on wether they were defined when a mode handler was set up with <a class="el" href="classServer.html#a19">Server::AddExtendedMode</a> If the mode is not a channel mode, chanrec* chan is null, and should not be read from or written to. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00104">104</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00118">118</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00104 { } +<div class="fragment"><pre>00118 { } </pre></div> </td> </tr> </table> @@ -310,9 +310,9 @@ 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00100">100</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00114">114</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00100 { } +<div class="fragment"><pre>00114 { } </pre></div> </td> </tr> </table> @@ -346,9 +346,9 @@ Called before a packet is transmitted across the irc network between two irc ser <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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00099">99</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00113">113</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00099 { } +<div class="fragment"><pre>00113 { } </pre></div> </td> </tr> </table> @@ -381,9 +381,9 @@ 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#l00101">101</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00115">115</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00101 { } +<div class="fragment"><pre>00115 { } </pre></div> </td> </tr> </table> @@ -426,9 +426,9 @@ 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. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00102">102</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00116">116</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00102 { } +<div class="fragment"><pre>00116 { } </pre></div> </td> </tr> </table> @@ -462,9 +462,9 @@ Called when a user connects. <p> The details of the connecting user are available to you in the parameter userrec *user <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00095">95</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00109">109</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00095 { } +<div class="fragment"><pre>00109 { } </pre></div> </td> </tr> </table> @@ -507,9 +507,9 @@ Called when a user joins a channel. <p> The details of the joining user are available to you in the parameter userrec *user, and the details of the channel they have joined is available in the variable chanrec *channel <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00097">97</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00111">111</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00097 { } +<div class="fragment"><pre>00111 { } </pre></div> </td> </tr> </table> @@ -552,9 +552,9 @@ Called when a user parts a channel. <p> The details of the leaving user are available to you in the parameter userrec *user, and the details of the channel they have left is available in the variable chanrec *channel <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00098">98</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00112">112</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00098 { } +<div class="fragment"><pre>00112 { } </pre></div> </td> </tr> </table> @@ -588,15 +588,15 @@ Called when a user quits. <p> The details of the exiting user are available to you in the parameter userrec *user <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00096">96</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00110">110</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -<div class="fragment"><pre>00096 { } +<div class="fragment"><pre>00110 { } </pre></div> </td> </tr> </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 Sat Apr 3 16:36:16 2004 for InspIRCd by +<hr><address style="align: right;"><small>Generated on Sun Apr 4 23:02:29 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> |