diff options
Diffstat (limited to 'docs/module-doc/modules_8h.html')
| -rw-r--r-- | docs/module-doc/modules_8h.html | 96 |
1 files changed, 96 insertions, 0 deletions
diff --git a/docs/module-doc/modules_8h.html b/docs/module-doc/modules_8h.html new file mode 100644 index 000000000..6c9237a27 --- /dev/null +++ b/docs/module-doc/modules_8h.html @@ -0,0 +1,96 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>modules.h File Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.3-rc2 --> +<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> +<hr><h1>modules.h File Reference</h1><code>#include "dynamic.h"</code><br> +<code>#include <string></code><br> +<code>#include <deque></code><br> + +<p> +<a href="modules_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td></td></tr> +<tr><td colspan=2><br><h2>Compounds</h2></td></tr> +<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classAdmin.html">Admin</a></td></tr> +<tr><td> </td><td><font size=-1><em>Holds /ADMIN data This class contains the admin details of the local server.</em> <a href="classAdmin.html#_details">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classConfigReader.html">ConfigReader</a></td></tr> +<tr><td> </td><td><font size=-1><em>Allows reading of values from configuration files This class allows a module to read from either the main configuration file (inspircd.conf) or from a module-specified configuration file.</em> <a href="classConfigReader.html#_details">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classFileReader.html">FileReader</a></td></tr> +<tr><td> </td><td><font size=-1><em>Caches a text file into memory and can be used to retrieve lines from it.</em> <a href="classFileReader.html#_details">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classModule.html">Module</a></td></tr> +<tr><td> </td><td><font size=-1><em>Base class for all InspIRCd modules This class is the base class for InspIRCd modules.</em> <a href="classModule.html#_details">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classModuleFactory.html">ModuleFactory</a></td></tr> +<tr><td> </td><td><font size=-1><em>Instantiates classes inherited from <a class="el" href="classModule.html">Module</a> This class creates a class inherited from type <a class="el" href="classModule.html">Module</a>, using new.</em> <a href="classModuleFactory.html#_details">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classServer.html">Server</a></td></tr> +<tr><td> </td><td><font size=-1><em>Allows server output and query functions This class contains methods which allow a module to query the state of the irc server, and produce output to users and other servers.</em> <a href="classServer.html#_details">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classVersion.html">Version</a></td></tr> +<tr><td> </td><td><font size=-1><em>Holds a module's Version information The four members (set by the constructor only) indicate details as to the version number of a module.</em> <a href="classVersion.html#_details">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Defines</h2></td></tr> +<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="modules_8h.html#a0">FOREACH_MOD</a> for (int i = 0; i <= MODCOUNT; 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#a1">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="#a1"></a><em></em></font><br><br></td></tr> +</table> +<hr><h2>Define Documentation</h2> +<a name="a0" 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 <= MODCOUNT; i++) modules[i]-> + </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#l00045">45</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. </td> + </tr> +</table> +<hr><h2>Typedef Documentation</h2> +<a name="a1" 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 + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Low level definition of a <a class="el" href="classFileReader.html">FileReader</a> classes file cache area. +<p> + +<p> +Definition at line <a class="el" href="modules_8h-source.html#l00038">38</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#l00195">FileReader::FileReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00206">FileReader::LoadFile()</a>. </td> + </tr> +</table> +<hr><address style="align: right;"><small>Generated on Wed Jan 22 20:56:47 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-rc2 </small></address> +</body> +</html> |