diff options
| author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-03-25 03:51:56 +0000 |
|---|---|---|
| committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-03-25 03:51:56 +0000 |
| commit | 52899de0ff2d62ca0542b243c41626010bf62083 (patch) | |
| tree | b9c92bbdb7d65a7467cbd6ebcbc31dc2f96e09e3 /docs/module-doc/channels_8h.html | |
| parent | 0340f1a432d684347d8dbc3aa85c8436c56d4039 (diff) | |
Documentation update
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@899 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/module-doc/channels_8h.html')
| -rw-r--r-- | docs/module-doc/channels_8h.html | 159 |
1 files changed, 77 insertions, 82 deletions
diff --git a/docs/module-doc/channels_8h.html b/docs/module-doc/channels_8h.html index d4d8fdea6..8bc451f8b 100644 --- a/docs/module-doc/channels_8h.html +++ b/docs/module-doc/channels_8h.html @@ -1,73 +1,68 @@ <!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>channels.h File Reference</title> +<title>InspIRCd: channels.h File 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>channels.h File Reference</h1><code>#include "inspircd_config.h"</code><br> +<!-- 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="functions.html">Compound Members</a> | <a class="qindex" href="globals.html">File Members</a></div> +<h1>channels.h File Reference</h1><code>#include "inspircd_config.h"</code><br> <code>#include "<a class="el" href="base_8h-source.html">base.h</a>"</code><br> <code>#include <time.h></code><br> <code>#include <vector></code><br> <code>#include <string></code><br> <p> -Include dependency graph for channels.h:<p><center><img src="channels_8h__incl.gif" border="0" usemap="#channels.h_map" alt="Include dependency graph"></center> -<map name="channels.h_map"> -<area href="base_8h.html" shape="rect" coords="139,85,187,106" alt=""> -</map> - -<p> -This graph shows which files directly or indirectly include this file:<p><center><img src="channels_8h__dep__incl.gif" border="0" usemap="#channels.hdep_map" alt="Included by dependency graph"></center> -<map name="channels.hdep_map"> -<area href="users_8cpp.html" shape="rect" coords="7,86,73,107" alt=""> -<area href="users_8h.html" shape="rect" coords="200,155,251,176" alt=""> -<area href="channels_8cpp.html" shape="rect" coords="373,16,461,38" alt=""> -<area href="message_8h.html" shape="rect" coords="327,86,399,107" alt=""> -<area href="mode_8h.html" shape="rect" coords="423,86,473,107" alt=""> -<area href="xline_8h.html" shape="rect" coords="255,86,303,107" alt=""> -<area href="modules_8cpp.html" shape="rect" coords="237,16,320,38" alt=""> -<area href="commands_8h.html" shape="rect" coords="97,86,180,107" alt=""> -</map> - -<p> <a href="channels_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0> <tr><td></td></tr> <tr><td colspan=2><br><h2>Compounds</h2></td></tr> -<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classBanItem.html">BanItem</a></td></tr> -<tr><td> </td><td><font size=-1><em>A subclass of <a class="el" href="classHostItem.html">HostItem</a> designed to hold channel bans (+b).</em> <a href="classBanItem.html#_details">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classchanrec.html">chanrec</a></td></tr> -<tr><td> </td><td><font size=-1><em>Holds all relevent information for a channel.</em> <a href="classchanrec.html#_details">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classExemptItem.html">ExemptItem</a></td></tr> -<tr><td> </td><td><font size=-1><em>A subclass of <a class="el" href="classHostItem.html">HostItem</a> designed to hold channel exempts (+e).</em> <a href="classExemptItem.html#_details">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classHostItem.html">HostItem</a></td></tr> -<tr><td> </td><td><font size=-1><em>Holds an entry for a ban list, exemption list, or invite list.</em> <a href="classHostItem.html#_details">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classInviteItem.html">InviteItem</a></td></tr> -<tr><td> </td><td><font size=-1><em>A subclass of <a class="el" href="classHostItem.html">HostItem</a> designed to hold channel invites (+I).</em> <a href="classInviteItem.html#_details">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classModeParameter.html">ModeParameter</a></td></tr> -<tr><td> </td><td><font size=-1><em>Holds a custom parameter to a module-defined channel mode e.g.</em> <a href="classModeParameter.html#_details">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classucrec.html">ucrec</a></td></tr> -<tr><td> </td><td><font size=-1><em>Holds a user's modes on a channel This class associates a users privilages with a channel by creating a pointer link between a userrec and chanrec class.</em> <a href="classucrec.html#_details">More...</a><em></em></font><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>class </td><td class="memItemRight" valign=bottom><a class="el" href="classBanItem.html">BanItem</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">A subclass of <a class="el" href="classHostItem.html">HostItem</a> designed to hold channel bans (+b). </em> <a href="classBanItem.html#_details">More...</a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>class </td><td class="memItemRight" valign=bottom><a class="el" href="classchanrec.html">chanrec</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds all relevent information for a channel. </em> <a href="classchanrec.html#_details">More...</a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>class </td><td class="memItemRight" valign=bottom><a class="el" href="classExemptItem.html">ExemptItem</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">A subclass of <a class="el" href="classHostItem.html">HostItem</a> designed to hold channel exempts (+e). </em> <a href="classExemptItem.html#_details">More...</a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>class </td><td class="memItemRight" valign=bottom><a class="el" href="classHostItem.html">HostItem</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds an entry for a ban list, exemption list, or invite list. </em> <a href="classHostItem.html#_details">More...</a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>class </td><td class="memItemRight" valign=bottom><a class="el" href="classInviteItem.html">InviteItem</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">A subclass of <a class="el" href="classHostItem.html">HostItem</a> designed to hold channel invites (+I). </em> <a href="classInviteItem.html#_details">More...</a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>class </td><td class="memItemRight" valign=bottom><a class="el" href="classModeParameter.html">ModeParameter</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds a custom parameter to a module-defined channel mode e.g. </em> <a href="classModeParameter.html#_details">More...</a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>class </td><td class="memItemRight" valign=bottom><a class="el" href="classucrec.html">ucrec</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds a user's modes on a channel This class associates a users privilages with a channel by creating a pointer link between a userrec and chanrec class. </em> <a href="classucrec.html#_details">More...</a><em><br><br></td></tr> <tr><td colspan=2><br><h2>Defines</h2></td></tr> -<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="channels_8h.html#a0">UCMODE_OP</a> 1</td></tr> -<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="channels_8h.html#a1">UCMODE_VOICE</a> 2</td></tr> -<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="channels_8h.html#a2">UCMODE_HOP</a> 4</td></tr> -<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="channels_8h.html#a3">UCMODE_PROTECT</a> 8</td></tr> -<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="channels_8h.html#a4">UCMODE_FOUNDER</a> 16</td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="channels_8h.html#a0">UCMODE_OP</a> 1</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="channels_8h.html#a1">UCMODE_VOICE</a> 2</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="channels_8h.html#a2">UCMODE_HOP</a> 4</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="channels_8h.html#a3">UCMODE_PROTECT</a> 8</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="channels_8h.html#a4">UCMODE_FOUNDER</a> 16</td></tr> + <tr><td colspan=2><br><h2>Typedefs</h2></td></tr> -<tr><td nowrap align=right valign=top>typedef std::vector< <a class="el" href="classBanItem.html">BanItem</a> > </td><td valign=bottom><a class="el" href="channels_8h.html#a5">BanList</a></td></tr> -<tr><td> </td><td><font size=-1><em>Holds a complete ban list.</em> <a href="#a5"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>typedef std::vector< <a class="el" href="classExemptItem.html">ExemptItem</a> > </td><td valign=bottom><a class="el" href="channels_8h.html#a6">ExemptList</a></td></tr> -<tr><td> </td><td><font size=-1><em>Holds a complete exempt list.</em> <a href="#a6"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>typedef std::vector< <a class="el" href="classInviteItem.html">InviteItem</a> > </td><td valign=bottom><a class="el" href="channels_8h.html#a7">InviteList</a></td></tr> -<tr><td> </td><td><font size=-1><em>Holds a complete invite list.</em> <a href="#a7"></a><em></em></font><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::vector< <a class="el" href="classBanItem.html">BanItem</a> > </td><td class="memItemRight" valign=bottom><a class="el" href="channels_8h.html#a5">BanList</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds a complete ban list. </em> <a href="#a5"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::vector< <a class="el" href="classExemptItem.html">ExemptItem</a> > </td><td class="memItemRight" valign=bottom><a class="el" href="channels_8h.html#a6">ExemptList</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds a complete exempt list. </em> <a href="#a6"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::vector< <a class="el" href="classInviteItem.html">InviteItem</a> > </td><td class="memItemRight" valign=bottom><a class="el" href="channels_8h.html#a7">InviteList</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds a complete invite list. </em> <a href="#a7"></a><em><br><br></td></tr> </table> <hr><h2>Define Documentation</h2> <a name="a4" doxytag="channels.h::UCMODE_FOUNDER"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> #define UCMODE_FOUNDER 16 @@ -85,13 +80,13 @@ This graph shows which files directly or indirectly include this file:<p><center <p> <p> -Definition at line <a class="el" href="channels_8h-source.html#l00184">184</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> +Definition at line <a class="el" href="channels_8h-source.html#l00195">195</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> </tr> </table> <a name="a2" doxytag="channels.h::UCMODE_HOP"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> #define UCMODE_HOP 4 @@ -109,13 +104,13 @@ Definition at line <a class="el" href="channels_8h-source.html#l00184">184</a> o <p> <p> -Definition at line <a class="el" href="channels_8h-source.html#l00182">182</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> +Definition at line <a class="el" href="channels_8h-source.html#l00193">193</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> </tr> </table> <a name="a0" doxytag="channels.h::UCMODE_OP"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> #define UCMODE_OP 1 @@ -133,13 +128,13 @@ Definition at line <a class="el" href="channels_8h-source.html#l00182">182</a> o <p> <p> -Definition at line <a class="el" href="channels_8h-source.html#l00180">180</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> +Definition at line <a class="el" href="channels_8h-source.html#l00191">191</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> </tr> </table> <a name="a3" doxytag="channels.h::UCMODE_PROTECT"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> #define UCMODE_PROTECT 8 @@ -157,13 +152,13 @@ Definition at line <a class="el" href="channels_8h-source.html#l00180">180</a> o <p> <p> -Definition at line <a class="el" href="channels_8h-source.html#l00183">183</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> +Definition at line <a class="el" href="channels_8h-source.html#l00194">194</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> </tr> </table> <a name="a1" doxytag="channels.h::UCMODE_VOICE"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> #define UCMODE_VOICE 2 @@ -181,17 +176,17 @@ Definition at line <a class="el" href="channels_8h-source.html#l00183">183</a> o <p> <p> -Definition at line <a class="el" href="channels_8h-source.html#l00181">181</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> +Definition at line <a class="el" href="channels_8h-source.html#l00192">192</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> </tr> </table> <hr><h2>Typedef Documentation</h2> <a name="a5" doxytag="channels.h::BanList"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> typedef std::vector<<a class="el" href="classBanItem.html">BanItem</a>> BanList + <td class="md" nowrap valign="top"> typedef std::vector<<a class="el" href="classBanItem.html">BanItem</a>> <a class="el" href="channels_8h.html#a5">BanList</a> </table> </td> </tr> @@ -204,20 +199,20 @@ Definition at line <a class="el" href="channels_8h-source.html#l00181">181</a> o <td> <p> -Holds a complete ban list. +Holds a complete ban list. <p> <p> -Definition at line <a class="el" href="channels_8h-source.html#l00069">69</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> +Definition at line <a class="el" href="channels_8h-source.html#l00080">80</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> </tr> </table> <a name="a6" doxytag="channels.h::ExemptList"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> typedef std::vector<<a class="el" href="classExemptItem.html">ExemptItem</a>> ExemptList + <td class="md" nowrap valign="top"> typedef std::vector<<a class="el" href="classExemptItem.html">ExemptItem</a>> <a class="el" href="channels_8h.html#a6">ExemptList</a> </table> </td> </tr> @@ -230,20 +225,20 @@ Definition at line <a class="el" href="channels_8h-source.html#l00069">69</a> of <td> <p> -Holds a complete exempt list. +Holds a complete exempt list. <p> <p> -Definition at line <a class="el" href="channels_8h-source.html#l00073">73</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> +Definition at line <a class="el" href="channels_8h-source.html#l00084">84</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> </tr> </table> <a name="a7" doxytag="channels.h::InviteList"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> typedef std::vector<<a class="el" href="classInviteItem.html">InviteItem</a>> InviteList + <td class="md" nowrap valign="top"> typedef std::vector<<a class="el" href="classInviteItem.html">InviteItem</a>> <a class="el" href="channels_8h.html#a7">InviteList</a> </table> </td> </tr> @@ -256,16 +251,16 @@ Definition at line <a class="el" href="channels_8h-source.html#l00073">73</a> of <td> <p> -Holds a complete invite list. +Holds a complete invite list. <p> <p> -Definition at line <a class="el" href="channels_8h-source.html#l00077">77</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> +Definition at line <a class="el" href="channels_8h-source.html#l00088">88</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>. </td> </tr> </table> -<hr><address style="align: right;"><small>Generated on Sun May 2 00:09:21 2004 for InspIRCd by +<hr size="1"><address style="align: right;"><small>Generated on Fri Mar 25 03:49:29 2005 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> +<img src="doxygen.png" alt="doxygen" align="middle" border=0 > +</a>1.3.3 </small></address> </body> </html> |