diff options
| author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-11-27 01:44:46 +0000 |
|---|---|---|
| committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-11-27 01:44:46 +0000 |
| commit | cd9f9a8add02597a2998ba74b803ed3fbf81314c (patch) | |
| tree | b53e3ea035c25a0580e9b31dc31f27ee33c36c96 /docs/module-doc/classModuleMessage.html | |
| parent | 91755849c3bdf089f4583c119fcbb90ff99bed5b (diff) | |
Added new documentation
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1966 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/module-doc/classModuleMessage.html')
| -rw-r--r-- | docs/module-doc/classModuleMessage.html | 79 |
1 files changed, 56 insertions, 23 deletions
diff --git a/docs/module-doc/classModuleMessage.html b/docs/module-doc/classModuleMessage.html index d194e7af9..4c1211a7b 100644 --- a/docs/module-doc/classModuleMessage.html +++ b/docs/module-doc/classModuleMessage.html @@ -1,56 +1,90 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> -<title>InspIRCd: ModuleMessage class Reference</title> +<title>InspIRCd: ModuleMessage Class Reference</title> <link href="inspircd.doxygen.css" rel="stylesheet" type="text/css"> </head><body> -<!-- Generated by Doxygen 1.3.3 --> -<div class="qindex"><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="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Compound Members</a> | <a class="qindex" href="globals.html">File Members</a></div> -<h1>ModuleMessage Class Reference</h1>The ModuleMessage class is the base class of <a class="el" href="classRequest.html">Request</a> and <a class="el" href="classEvent.html">Event</a> This class is used to represent a basic data structure which is passed between modules for safe inter-module communications. +<!-- Generated by Doxygen 1.4.4-20050815 --> +<div class="qindex"><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">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div> +<h1>ModuleMessage Class Reference</h1><!-- doxytag: class="ModuleMessage" --><!-- doxytag: inherits="classbase" -->The ModuleMessage class is the base class of <a class="el" href="classRequest.html">Request</a> and <a class="el" href="classEvent.html">Event</a> This class is used to represent a basic data structure which is passed between modules for safe inter-module communications. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="modules_8h-source.html">modules.h</a>></code> <p> Inheritance diagram for ModuleMessage:<p><center><img src="classModuleMessage__inherit__graph.gif" border="0" usemap="#ModuleMessage__inherit__map" alt="Inheritance graph"></center> <map name="ModuleMessage__inherit__map"> -<area href="classEvent.html" shape="rect" coords="8,157,64,184" alt=""> -<area href="classRequest.html" shape="rect" coords="88,157,160,184" alt=""> -<area href="classclassbase.html" shape="rect" coords="40,8,120,34" alt=""> +<area href="classEvent.html" shape="rect" coords="7,156,63,183" alt=""> +<area href="classRequest.html" shape="rect" coords="87,156,159,183" alt=""> +<area href="classclassbase.html" shape="rect" coords="39,7,119,33" alt=""> </map> <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for ModuleMessage:<p><center><img src="classModuleMessage__coll__graph.gif" border="0" usemap="#ModuleMessage__coll__map" alt="Collaboration graph"></center> <map name="ModuleMessage__coll__map"> -<area href="classclassbase.html" shape="rect" coords="28,98,108,125" alt=""> +<area href="classclassbase.html" shape="rect" coords="27,97,107,124" alt=""> </map> -<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classModuleMessage-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classModuleMessage-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> -<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>virtual char * </td><td class="memItemRight" valign=bottom><a class="el" href="classModuleMessage.html#a0">Send</a> ()=0</td></tr> +<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classModuleMessage.html#Send_28_29_3D_30">Send</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">This class is pure virtual and must be inherited. <a href="#Send_28_29_3D_30"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classModuleMessage.html#_7EModuleMessage_28_29">~ModuleMessage</a> ()</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">This class is pure virtual and must be inherited. </em> <a href="#a0"></a><em><br><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> The ModuleMessage class is the base class of <a class="el" href="classRequest.html">Request</a> and <a class="el" href="classEvent.html">Event</a> This class is used to represent a basic data structure which is passed between modules for safe inter-module communications. <p> <p> -Definition at line <a class="el" href="modules_8h-source.html#l00141">141</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Member Function Documentation</h2> -<a name="a0" doxytag="ModuleMessage::Send"></a><p> -<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> +Definition at line <a class="el" href="modules_8h-source.html#l00142">142</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="_7EModuleMessage_28_29"></a><!-- doxytag: member="ModuleMessage::~ModuleMessage" ref="_7EModuleMessage_28_29" args="()" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> virtual char* ModuleMessage::Send </td> + <td class="md" nowrap valign="top">virtual ModuleMessage::~ModuleMessage </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> - <td class="md" nowrap><code> [pure virtual]</code></td> + <td class="md" nowrap><code> [inline, virtual]</code></td> </tr> + </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#l00148">148</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<div class="fragment"><pre class="fragment"><a name="l00148"></a>00148 {}; +</pre></div> +<p> + </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="Send_28_29_3D_30"></a><!-- doxytag: member="ModuleMessage::Send" ref="Send_28_29_3D_30" args="()=0" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">virtual char* ModuleMessage::Send </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> </table> </td> </tr> </table> -<table cellspacing=5 cellpadding=0 border=0> +<table cellspacing="5" cellpadding="0" border="0"> <tr> <td> @@ -62,14 +96,13 @@ This class is pure virtual and must be inherited. <p> <p> -Implemented in <a class="el" href="classRequest.html#a4">Request</a>, and <a class="el" href="classEvent.html#a4">Event</a>. </td> +Implemented in <a class="el" href="classRequest.html#Send_28_29">Request</a>, and <a class="el" href="classEvent.html#Send_28_29">Event</a>. </td> </tr> </table> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="modules_8h-source.html">modules.h</a></ul> -<hr size="1"><address style="align: right;"><small>Generated on Mon May 30 05:17:27 2005 for InspIRCd by +<hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:26 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> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address> </body> </html> |