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/classcommand__t.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/classcommand__t.html')
| -rw-r--r-- | docs/module-doc/classcommand__t.html | 118 |
1 files changed, 62 insertions, 56 deletions
diff --git a/docs/module-doc/classcommand__t.html b/docs/module-doc/classcommand__t.html index 81278b3ca..ce2282e17 100644 --- a/docs/module-doc/classcommand__t.html +++ b/docs/module-doc/classcommand__t.html @@ -1,49 +1,49 @@ -<!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: command_t class Reference</title> +<title>InspIRCd: command_t 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>command_t Class Reference</h1>A structure that defines a command. +<!-- 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>command_t Class Reference</h1><!-- doxytag: class="command_t" --><!-- doxytag: inherits="Extensible" -->A structure that defines a command. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="ctables_8h-source.html">ctables.h</a>></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="classExtensible.html" shape="rect" coords="12,82,94,109" alt=""> -<area href="classclassbase.html" shape="rect" coords="13,8,93,34" alt=""> +<area href="classExtensible.html" shape="rect" coords="11,81,93,108" alt=""> +<area href="classclassbase.html" shape="rect" coords="12,7,92,33" 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="classExtensible.html" shape="rect" coords="81,98,164,125" alt=""> -<area href="classclassbase.html" shape="rect" coords="8,8,88,34" alt=""> +<area href="classExtensible.html" shape="rect" coords="80,97,163,124" alt=""> +<area href="classclassbase.html" shape="rect" coords="7,7,87,33" alt=""> </map> -<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> +<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 class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classcommand__t.html#o0">command</a> [MAXBUF]</td></tr> +<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="classcommand__t.html#command_5BMAXBUF_5D">command</a> [MAXBUF]</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Command name. </em> <a href="#o0"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>handlerfunc * </td><td class="memItemRight" valign=bottom><a class="el" href="classcommand__t.html#o1">handler_function</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Command name. <a href="#command_5BMAXBUF_5D"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">handlerfunc * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcommand__t.html#handler_5Ffunction">handler_function</a></td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Handler function as in typedef. </em> <a href="#o1"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classcommand__t.html#o2">flags_needed</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handler function as in typedef. <a href="#handler_5Ffunction"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="classcommand__t.html#flags_5Fneeded">flags_needed</a></td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">User flags needed to execute the command or 0. </em> <a href="#o2"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classcommand__t.html#o3">min_params</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">User flags needed to execute the command or 0. <a href="#flags_5Fneeded"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcommand__t.html#min_5Fparams">min_params</a></td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Minimum number of parameters command takes. </em> <a href="#o3"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>long </td><td class="memItemRight" valign=bottom><a class="el" href="classcommand__t.html#o4">use_count</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Minimum number of parameters command takes. <a href="#min_5Fparams"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classcommand__t.html#use_5Fcount">use_count</a></td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">used by /stats m </em> <a href="#o4"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>long </td><td class="memItemRight" valign=bottom><a class="el" href="classcommand__t.html#o5">total_bytes</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">used by /stats m <a href="#use_5Fcount"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classcommand__t.html#total_5Fbytes">total_bytes</a></td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">used by /stats m </em> <a href="#o5"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classcommand__t.html#o6">source</a> [MAXBUF]</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">used by /stats m <a href="#total_5Fbytes"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="classcommand__t.html#source_5BMAXBUF_5D">source</a> [MAXBUF]</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">used for resource tracking between modules </em> <a href="#o6"></a><em><br><br></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">used for resource tracking between modules <a href="#source_5BMAXBUF_5D"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> A structure that defines a command. @@ -51,18 +51,19 @@ A structure that defines a command. <p> Definition at line <a class="el" href="ctables_8h-source.html#l00026">26</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>.<hr><h2>Member Data Documentation</h2> -<a name="o0" doxytag="command_t::command"></a><p> -<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> +<a class="anchor" name="command_5BMAXBUF_5D"></a><!-- doxytag: member="command_t::command" ref="command_5BMAXBUF_5D" args="[MAXBUF]" --><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"> char <a class="el" href="classcommand__t.html#o0">command_t::command</a>[MAXBUF] + <td class="md" nowrap valign="top">char <a class="el" href="classcommand__t.html#command_5BMAXBUF_5D">command_t::command</a>[MAXBUF] </td> + </tr> </table> </td> </tr> </table> -<table cellspacing=5 cellpadding=0 border=0> +<table cellspacing="5" cellpadding="0" border="0"> <tr> <td> @@ -77,18 +78,19 @@ Command name. Definition at line <a class="el" href="ctables_8h-source.html#l00031">31</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>. </td> </tr> </table> -<a name="o2" doxytag="command_t::flags_needed"></a><p> -<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> +<a class="anchor" name="flags_5Fneeded"></a><!-- doxytag: member="command_t::flags_needed" ref="flags_5Fneeded" 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"> char <a class="el" href="classcommand__t.html#o2">command_t::flags_needed</a> + <td class="md" nowrap valign="top">char <a class="el" href="classcommand__t.html#flags_5Fneeded">command_t::flags_needed</a> </td> + </tr> </table> </td> </tr> </table> -<table cellspacing=5 cellpadding=0 border=0> +<table cellspacing="5" cellpadding="0" border="0"> <tr> <td> @@ -103,18 +105,19 @@ User flags needed to execute the command or 0. Definition at line <a class="el" href="ctables_8h-source.html#l00037">37</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>. </td> </tr> </table> -<a name="o1" doxytag="command_t::handler_function"></a><p> -<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> +<a class="anchor" name="handler_5Ffunction"></a><!-- doxytag: member="command_t::handler_function" ref="handler_5Ffunction" 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"> handlerfunc* <a class="el" href="classcommand__t.html#o1">command_t::handler_function</a> + <td class="md" nowrap valign="top">handlerfunc* <a class="el" href="classcommand__t.html#handler_5Ffunction">command_t::handler_function</a> </td> + </tr> </table> </td> </tr> </table> -<table cellspacing=5 cellpadding=0 border=0> +<table cellspacing="5" cellpadding="0" border="0"> <tr> <td> @@ -129,18 +132,19 @@ Handler function as in typedef. Definition at line <a class="el" href="ctables_8h-source.html#l00034">34</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>. </td> </tr> </table> -<a name="o3" doxytag="command_t::min_params"></a><p> -<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> +<a class="anchor" name="min_5Fparams"></a><!-- doxytag: member="command_t::min_params" ref="min_5Fparams" 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"> int <a class="el" href="classcommand__t.html#o3">command_t::min_params</a> + <td class="md" nowrap valign="top">int <a class="el" href="classcommand__t.html#min_5Fparams">command_t::min_params</a> </td> + </tr> </table> </td> </tr> </table> -<table cellspacing=5 cellpadding=0 border=0> +<table cellspacing="5" cellpadding="0" border="0"> <tr> <td> @@ -155,18 +159,19 @@ Minimum number of parameters command takes. Definition at line <a class="el" href="ctables_8h-source.html#l00040">40</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>. </td> </tr> </table> -<a name="o6" doxytag="command_t::source"></a><p> -<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> +<a class="anchor" name="source_5BMAXBUF_5D"></a><!-- doxytag: member="command_t::source" ref="source_5BMAXBUF_5D" args="[MAXBUF]" --><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"> char <a class="el" href="classcommand__t.html#o6">command_t::source</a>[MAXBUF] + <td class="md" nowrap valign="top">char <a class="el" href="classcommand__t.html#source_5BMAXBUF_5D">command_t::source</a>[MAXBUF] </td> + </tr> </table> </td> </tr> </table> -<table cellspacing=5 cellpadding=0 border=0> +<table cellspacing="5" cellpadding="0" border="0"> <tr> <td> @@ -181,18 +186,19 @@ used for resource tracking between modules Definition at line <a class="el" href="ctables_8h-source.html#l00049">49</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>. </td> </tr> </table> -<a name="o5" doxytag="command_t::total_bytes"></a><p> -<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> +<a class="anchor" name="total_5Fbytes"></a><!-- doxytag: member="command_t::total_bytes" ref="total_5Fbytes" 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"> long <a class="el" href="classcommand__t.html#o5">command_t::total_bytes</a> + <td class="md" nowrap valign="top">long <a class="el" href="classcommand__t.html#total_5Fbytes">command_t::total_bytes</a> </td> + </tr> </table> </td> </tr> </table> -<table cellspacing=5 cellpadding=0 border=0> +<table cellspacing="5" cellpadding="0" border="0"> <tr> <td> @@ -207,18 +213,19 @@ used by /stats m Definition at line <a class="el" href="ctables_8h-source.html#l00046">46</a> of file <a class="el" href="ctables_8h-source.html">ctables.h</a>. </td> </tr> </table> -<a name="o4" doxytag="command_t::use_count"></a><p> -<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> +<a class="anchor" name="use_5Fcount"></a><!-- doxytag: member="command_t::use_count" ref="use_5Fcount" 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"> long <a class="el" href="classcommand__t.html#o4">command_t::use_count</a> + <td class="md" nowrap valign="top">long <a class="el" href="classcommand__t.html#use_5Fcount">command_t::use_count</a> </td> + </tr> </table> </td> </tr> </table> -<table cellspacing=5 cellpadding=0 border=0> +<table cellspacing="5" cellpadding="0" border="0"> <tr> <td> @@ -235,9 +242,8 @@ Definition at line <a class="el" href="ctables_8h-source.html#l00043">43</a> of </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 size="1"><address style="align: right;"><small>Generated on Mon May 30 05:16:39 2005 for InspIRCd by +<hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:25 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> |