diff options
| author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2004-04-04 22:03:32 +0000 |
|---|---|---|
| committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2004-04-04 22:03:32 +0000 |
| commit | 78a96055c428d1970ece93dfb01902ac0d1699bd (patch) | |
| tree | b0df96bae212f97c67ebf2339d40454f2283e5d3 /docs/module-doc/classModeParameter.html | |
| parent | db6ed68db7e38e21a9ce66cecaf42006f034dc62 (diff) | |
New documentation to document user/channel mode handling
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@380 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/module-doc/classModeParameter.html')
| -rw-r--r-- | docs/module-doc/classModeParameter.html | 122 |
1 files changed, 122 insertions, 0 deletions
diff --git a/docs/module-doc/classModeParameter.html b/docs/module-doc/classModeParameter.html new file mode 100644 index 000000000..3acbd039e --- /dev/null +++ b/docs/module-doc/classModeParameter.html @@ -0,0 +1,122 @@ +<!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>ModeParameter class Reference</title> +<link href="inspircd.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.3-rc3 --> +<center> +<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="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center> +<hr><h1>ModeParameter Class Reference</h1>Holds a custom parameter to a module-defined channel mode e.g. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="channels_8h-source.html">channels.h</a>></code> +<p> +Inheritance diagram for ModeParameter:<p><center><img src="classModeParameter__inherit__graph.gif" border="0" usemap="#ModeParameter__inherit__map" alt="Inheritance graph"></center> +<map name="ModeParameter__inherit__map"> +<area href="classclassbase.html" shape="rect" coords="25,16,92,37" alt=""> +</map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for ModeParameter:<p><center><img src="classModeParameter__coll__graph.gif" border="0" usemap="#ModeParameter__coll__map" alt="Collaboration graph"></center> +<map name="ModeParameter__coll__map"> +<area href="classclassbase.html" shape="rect" coords="7,107,73,128" alt=""> +</map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classModeParameter-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 </td><td valign=bottom><a class="el" href="classModeParameter.html#m0">mode</a></td></tr> +<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classModeParameter.html#m1">parameter</a> [MAXBUF]</td></tr> +<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classModeParameter.html#m2">channel</a> [CHANMAX]</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Holds a custom parameter to a module-defined channel mode e.g. +<p> +for +L this would hold the channel name. +<p> + +<p> +Definition at line <a class="el" href="channels_8h-source.html#l00059">59</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.<hr><h2>Member Data Documentation</h2> +<a name="m2" doxytag="ModeParameter::channel"></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"> char ModeParameter::channel[CHANMAX] + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="channels_8h-source.html#l00064">64</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. +<p> +Referenced by <a class="el" href="channels_8cpp-source.html#l00050">chanrec::SetCustomModeParam()</a>. </td> + </tr> +</table> +<a name="m0" doxytag="ModeParameter::mode"></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"> char ModeParameter::mode + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="channels_8h-source.html#l00062">62</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. +<p> +Referenced by <a class="el" href="channels_8cpp-source.html#l00050">chanrec::SetCustomModeParam()</a>. </td> + </tr> +</table> +<a name="m1" doxytag="ModeParameter::parameter"></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"> char ModeParameter::parameter[MAXBUF] + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="channels_8h-source.html#l00063">63</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. +<p> +Referenced by <a class="el" href="channels_8cpp-source.html#l00050">chanrec::SetCustomModeParam()</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="channels_8h-source.html">channels.h</a></ul> +<hr><address style="align: right;"><small>Generated on Sun Apr 4 23:02:29 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-rc3 </small></address> +</body> +</html> |