]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/module-doc/classcommand__t.html
New documentation to document user/channel mode handling
[user/henk/code/inspircd.git] / docs / module-doc / classcommand__t.html
index 5b936e062af6ae1bfa0559de00857bfbbf9f95db..f020c08e0358b6f9167cd7b92f98d2f8244bcd11 100644 (file)
@@ -1,29 +1,46 @@
 <!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>command_t class Reference</title>
-<link href="doxygen.css" rel="stylesheet" type="text/css">
+<link href="inspircd.css" rel="stylesheet" type="text/css">
 </head><body>
-<!-- Generated by Doxygen 1.3-rc2 -->
+<!-- Generated by Doxygen 1.3-rc3 -->
 <center>
-<a class="qindex" href="main.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
-<hr><h1>command_t Class Reference</h1><code>#include &lt;<a class="el" href="ctables_8h-source.html">ctables.h</a>&gt;</code>
+<a class="qindex" href="main.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
+<hr><h1>command_t Class Reference</h1>A structure that defines a command. 
+<a href="#_details">More...</a>
 <p>
-<p>Inheritance diagram for command_t:
-<p><center><img src="classcommand__t.png" usemap="#command_t_map" border="0" alt=""></center>
-<map name="command_t_map">
-<area href="classclassbase.html" alt="classbase" shape="rect" coords="0,0,75,24">
+<code>#include &lt;<a class="el" href="ctables_8h-source.html">ctables.h</a>&gt;</code>
+<p>
+Inheritance diagram for command_t:<p><center><img src="classcommand__t__inherit__graph.gif" border="0" usemap="#command__t__inherit__map" alt="Inheritance graph"></center>
+<map name="command__t__inherit__map">
+<area href="classclassbase.html" shape="rect" coords="12,16,79,37" alt="">
+</map>
+<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for command_t:<p><center><img src="classcommand__t__coll__graph.gif" border="0" usemap="#command__t__coll__map" alt="Collaboration graph"></center>
+<map name="command__t__coll__map">
+<area href="classclassbase.html" shape="rect" coords="29,8,96,29" alt="">
 </map>
-<a href="classcommand__t-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="classcommand__t-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 Attributes</h2></td></tr>
 <tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="classcommand__t.html#m0">command</a> [MAXBUF]</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Command name.</em> <a href="#m0"></a><em></em></font><br><br></td></tr>
 <tr><td nowrap align=right valign=top><a class="el" href="ctables_8h.html#a0">handlerfunc</a> *&nbsp;</td><td valign=bottom><a class="el" href="classcommand__t.html#m1">handler_function</a></td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Handler function as in typedef.</em> <a href="#m1"></a><em></em></font><br><br></td></tr>
 <tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="classcommand__t.html#m2">flags_needed</a></td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>User flags needed to execute the command or 0.</em> <a href="#m2"></a><em></em></font><br><br></td></tr>
 <tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classcommand__t.html#m3">min_params</a></td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Minimum number of parameters command takes.</em> <a href="#m3"></a><em></em></font><br><br></td></tr>
 <tr><td nowrap align=right valign=top>long&nbsp;</td><td valign=bottom><a class="el" href="classcommand__t.html#m4">use_count</a></td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>used by /stats m</em> <a href="#m4"></a><em></em></font><br><br></td></tr>
 <tr><td nowrap align=right valign=top>long&nbsp;</td><td valign=bottom><a class="el" href="classcommand__t.html#m5">total_bytes</a></td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>used by /stats m</em> <a href="#m5"></a><em></em></font><br><br></td></tr>
 </table>
-<hr><h2>Member Data Documentation</h2>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+A structure that defines a command.
+<p>
+
+<p>
+Definition at line <a class="el" href="ctables_8h-source.html#l00027">27</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.<hr><h2>Member Data Documentation</h2>
 <a name="m0" doxytag="command_t::command"></a><p>
 <table width="100%" cellpadding="2" cellspacing="0" border="0">
   <tr>
     <td>
 
 <p>
+Command name.
+<p>
 
 <p>
-Definition at line <a class="el" href="ctables_8h-source.html#l00051">51</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.    </td>
+Definition at line <a class="el" href="ctables_8h-source.html#l00032">32</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.    </td>
   </tr>
 </table>
 <a name="m2" doxytag="command_t::flags_needed"></a><p>
@@ -67,9 +86,11 @@ Definition at line <a class="el" href="ctables_8h-source.html#l00051">51</a> of
     <td>
 
 <p>
+User flags needed to execute the command or 0.
+<p>
 
 <p>
-Definition at line <a class="el" href="ctables_8h-source.html#l00053">53</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.    </td>
+Definition at line <a class="el" href="ctables_8h-source.html#l00038">38</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.    </td>
   </tr>
 </table>
 <a name="m1" doxytag="command_t::handler_function"></a><p>
@@ -91,9 +112,11 @@ Definition at line <a class="el" href="ctables_8h-source.html#l00053">53</a> of
     <td>
 
 <p>
+Handler function as in typedef.
+<p>
 
 <p>
-Definition at line <a class="el" href="ctables_8h-source.html#l00052">52</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.    </td>
+Definition at line <a class="el" href="ctables_8h-source.html#l00035">35</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.    </td>
   </tr>
 </table>
 <a name="m3" doxytag="command_t::min_params"></a><p>
@@ -115,9 +138,11 @@ Definition at line <a class="el" href="ctables_8h-source.html#l00052">52</a> of
     <td>
 
 <p>
+Minimum number of parameters command takes.
+<p>
 
 <p>
-Definition at line <a class="el" href="ctables_8h-source.html#l00054">54</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.    </td>
+Definition at line <a class="el" href="ctables_8h-source.html#l00041">41</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.    </td>
   </tr>
 </table>
 <a name="m5" doxytag="command_t::total_bytes"></a><p>
@@ -139,9 +164,11 @@ Definition at line <a class="el" href="ctables_8h-source.html#l00054">54</a> of
     <td>
 
 <p>
+used by /stats m
+<p>
 
 <p>
-Definition at line <a class="el" href="ctables_8h-source.html#l00056">56</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.    </td>
+Definition at line <a class="el" href="ctables_8h-source.html#l00047">47</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.    </td>
   </tr>
 </table>
 <a name="m4" doxytag="command_t::use_count"></a><p>
@@ -163,16 +190,18 @@ Definition at line <a class="el" href="ctables_8h-source.html#l00056">56</a> of
     <td>
 
 <p>
+used by /stats m
+<p>
 
 <p>
-Definition at line <a class="el" href="ctables_8h-source.html#l00055">55</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.    </td>
+Definition at line <a class="el" href="ctables_8h-source.html#l00044">44</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.    </td>
   </tr>
 </table>
 <hr>The documentation for this class was generated from the following file:<ul>
 <li><a class="el" href="ctables_8h-source.html">ctables.h</a></ul>
-<hr><address style="align: right;"><small>Generated on Mon Jan 27 00:16:42 2003 for InspIRCd by
+<hr><address style="align: right;"><small>Generated on Sun Apr 4 23:02:24 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-rc2 </small></address>
+width=110 height=53></a>1.3-rc3 </small></address>
 </body>
 </html>