diff options
| author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2004-04-02 12:38:41 +0000 |
|---|---|---|
| committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2004-04-02 12:38:41 +0000 |
| commit | a753fb1bc711e10794e939e424f3cdd703116d82 (patch) | |
| tree | bf17b41965232848b840c4340f74bec3741afae2 /docs/module-doc/modules_8h.html | |
| parent | 0ae832406f989194761528a1b8d49aa115c7fb3b (diff) | |
Added support for modules to create commands - this needs a proof-of-concept module yet, do not use unless you like to live dangerously.
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@351 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/module-doc/modules_8h.html')
| -rw-r--r-- | docs/module-doc/modules_8h.html | 187 |
1 files changed, 172 insertions, 15 deletions
diff --git a/docs/module-doc/modules_8h.html b/docs/module-doc/modules_8h.html index 6bc8a7c8c..2ba5b9dad 100644 --- a/docs/module-doc/modules_8h.html +++ b/docs/module-doc/modules_8h.html @@ -8,13 +8,15 @@ <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> <hr><h1>modules.h File Reference</h1><code>#include "dynamic.h"</code><br> <code>#include "<a class="el" href="base_8h-source.html">base.h</a>"</code><br> +<code>#include "<a class="el" href="ctables_8h-source.html">ctables.h</a>"</code><br> <code>#include <string></code><br> <code>#include <deque></code><br> <p> Include dependency graph for modules.h:<p><center><img src="modules_8h__incl.gif" border="0" usemap="#modules.h_map" alt="Include dependency graph"></center> <map name="modules.h_map"> -<area href="base_8h.html" shape="rect" coords="100,85,148,106" alt=""> +<area href="base_8h.html" shape="rect" coords="91,86,139,107" alt=""> +<area href="ctables_8h.html" shape="rect" coords="151,155,212,176" alt=""> </map> <p> @@ -47,11 +49,17 @@ This graph shows which files directly or indirectly include this file:<p><center <tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="modules_8h.html#a2">DEFAULT</a> 30</td></tr> <tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="modules_8h.html#a3">SPARSE</a> 40</td></tr> <tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="modules_8h.html#a4">NONE</a> 50</td></tr> -<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="modules_8h.html#a5">FOREACH_MOD</a> for (int i = 0; i <= <a class="el" href="modules_8cpp.html#a0">MODCOUNT</a>; i++) modules[i]-></td></tr> +<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="modules_8h.html#a5">MT_CHANNEL</a> 1</td></tr> +<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="modules_8h.html#a6">MT_CLIENT</a> 2</td></tr> +<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="modules_8h.html#a7">MT_SERVER</a> 3</td></tr> +<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="modules_8h.html#a8">FOREACH_MOD</a> for (int i = 0; i <= <a class="el" href="modules_8cpp.html#a3">MODCOUNT</a>; i++) modules[i]-></td></tr> <tr><td colspan=2><br><h2>Typedefs</h2></td></tr> -<tr><td nowrap align=right valign=top>typedef deque< string > </td><td valign=bottom><a class="el" href="modules_8h.html#a6">file_cache</a></td></tr> -<tr><td> </td><td><font size=-1><em>Low level definition of a <a class="el" href="classFileReader.html">FileReader</a> classes file cache area.</em> <a href="#a6"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>typedef DLLFactory< <a class="el" href="classModuleFactory.html">ModuleFactory</a> > </td><td valign=bottom><a class="el" href="modules_8h.html#a7">ircd_module</a></td></tr> +<tr><td nowrap align=right valign=top>typedef std::deque< std::string > </td><td valign=bottom><a class="el" href="modules_8h.html#a9">file_cache</a></td></tr> +<tr><td> </td><td><font size=-1><em>Low level definition of a <a class="el" href="classFileReader.html">FileReader</a> classes file cache area.</em> <a href="#a9"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>typedef <a class="el" href="modules_8h.html#a9">file_cache</a> </td><td valign=bottom><a class="el" href="modules_8h.html#a10">string_list</a></td></tr> +<tr><td nowrap align=right valign=top>typedef DLLFactory< <a class="el" href="classModuleFactory.html">ModuleFactory</a> > </td><td valign=bottom><a class="el" href="modules_8h.html#a11">ircd_module</a></td></tr> +<tr><td colspan=2><br><h2>Functions</h2></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="modules_8h.html#a12">createcommand</a> (char *cmd, <a class="el" href="ctables_8h.html#a0">handlerfunc</a> f, char flags, int minparams)</td></tr> </table> <hr><h2>Define Documentation</h2> <a name="a0" doxytag="modules.h::DEBUG"></a><p> @@ -102,13 +110,13 @@ Definition at line <a class="el" href="modules_8h-source.html#l00011">11</a> of Definition at line <a class="el" href="modules_8h-source.html#l00013">13</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td> </tr> </table> -<a name="a5" doxytag="modules.h::FOREACH_MOD"></a><p> +<a name="a8" doxytag="modules.h::FOREACH_MOD"></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"> #define FOREACH_MOD for (int i = 0; i <= <a class="el" href="modules_8cpp.html#a0">MODCOUNT</a>; i++) modules[i]-> + <td class="md" nowrap valign="top"> #define FOREACH_MOD for (int i = 0; i <= <a class="el" href="modules_8cpp.html#a3">MODCOUNT</a>; i++) modules[i]-> </table> </td> </tr> @@ -123,7 +131,79 @@ Definition at line <a class="el" href="modules_8h-source.html#l00013">13</a> of <p> <p> -Definition at line <a class="el" href="modules_8h-source.html#l00031">31</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td> +Definition at line <a class="el" href="modules_8h-source.html#l00036">36</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td> + </tr> +</table> +<a name="a5" doxytag="modules.h::MT_CHANNEL"></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"> #define MT_CHANNEL 1 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="modules_8h-source.html#l00017">17</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td> + </tr> +</table> +<a name="a6" doxytag="modules.h::MT_CLIENT"></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"> #define MT_CLIENT 2 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="modules_8h-source.html#l00018">18</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td> + </tr> +</table> +<a name="a7" doxytag="modules.h::MT_SERVER"></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"> #define MT_SERVER 3 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="modules_8h-source.html#l00019">19</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td> </tr> </table> <a name="a4" doxytag="modules.h::NONE"></a><p> @@ -199,13 +279,13 @@ Definition at line <a class="el" href="modules_8h-source.html#l00012">12</a> of </tr> </table> <hr><h2>Typedef Documentation</h2> -<a name="a6" doxytag="modules.h::file_cache"></a><p> +<a name="a9" doxytag="modules.h::file_cache"></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"> typedef deque<string> file_cache + <td class="md" nowrap valign="top"> typedef std::deque<std::string> file_cache </table> </td> </tr> @@ -222,12 +302,12 @@ Low level definition of a <a class="el" href="classFileReader.html">FileReader</ <p> <p> -Definition at line <a class="el" href="modules_8h-source.html#l00024">24</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. +Definition at line <a class="el" href="modules_8h-source.html#l00029">29</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. <p> -Referenced by <a class="el" href="modules_8cpp-source.html#l00186">FileReader::FileReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00197">FileReader::LoadFile()</a>. </td> +Referenced by <a class="el" href="modules_8cpp-source.html#l00258">FileReader::FileReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00269">FileReader::LoadFile()</a>. </td> </tr> </table> -<a name="a7" doxytag="modules.h::ircd_module"></a><p> +<a name="a11" doxytag="modules.h::ircd_module"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> @@ -248,10 +328,87 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00186">FileReader::F <p> <p> -Definition at line <a class="el" href="modules_8h-source.html#l00355">355</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td> +Definition at line <a class="el" href="modules_8h-source.html#l00406">406</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td> + </tr> +</table> +<a name="a10" doxytag="modules.h::string_list"></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"> typedef <a class="el" href="modules_8h.html#a9">file_cache</a> string_list + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="modules_8h-source.html#l00030">30</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td> + </tr> +</table> +<hr><h2>Function Documentation</h2> +<a name="a12" doxytag="modules.h::createcommand"></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"> void createcommand </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">char * </td> + <td class="mdname" nowrap> <em>cmd</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="ctables_8h.html#a0">handlerfunc</a> </td> + <td class="mdname" nowrap> <em>f</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>char </td> + <td class="mdname" nowrap> <em>flags</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>int </td> + <td class="mdname" nowrap> <em>minparams</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Referenced by <a class="el" href="modules_8cpp-source.html#l00123">Server::AddCommand()</a>. </td> </tr> </table> -<hr><address style="align: right;"><small>Generated on Sun Mar 30 19:35:14 2003 for InspIRCd by +<hr><address style="align: right;"><small>Generated on Fri Apr 2 13:37:31 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> |