summaryrefslogtreecommitdiff
path: root/docs/module-doc/classcommand__t.html
diff options
context:
space:
mode:
authorbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2003-02-09 12:49:00 +0000
committerbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2003-02-09 12:49:00 +0000
commit08e384bb24398224856c44baa51b51977644de9d (patch)
tree15363f194893e4dc31b0de9fb509e52a32ad53b5 /docs/module-doc/classcommand__t.html
parent1f487855a5097c65aaad4752df259b9a877ba364 (diff)
Documentation update, 09/02/03
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@167 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/module-doc/classcommand__t.html')
-rw-r--r--docs/module-doc/classcommand__t.html44
1 files changed, 35 insertions, 9 deletions
diff --git a/docs/module-doc/classcommand__t.html b/docs/module-doc/classcommand__t.html
index 6e1ab9c18..28fe4e37d 100644
--- a/docs/module-doc/classcommand__t.html
+++ b/docs/module-doc/classcommand__t.html
@@ -6,7 +6,10 @@
<!-- Generated by Doxygen 1.3-rc2 -->
<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>
+<hr><h1>command_t Class Reference</h1>A structure that defines a command.
+<a href="#_details">More...</a>
+<p>
+<code>#include &lt;<a class="el" href="ctables_8h-source.html">ctables.h</a>&gt;</code>
<p>
<p>Inheritance diagram for command_t:
<p><center><img src="classcommand__t.png" usemap="#command_t_map" border="0" alt=""></center>
@@ -17,13 +20,24 @@
<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>
@@ -43,9 +57,11 @@
<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 +83,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 +109,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 +135,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 +161,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,14 +187,16 @@ 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:23:12 2003 for InspIRCd by
+<hr><address style="align: right;"><small>Generated on Sun Feb 9 12:48:17 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>