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/users_8h.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/users_8h.html')
| -rw-r--r-- | docs/module-doc/users_8h.html | 163 |
1 files changed, 85 insertions, 78 deletions
diff --git a/docs/module-doc/users_8h.html b/docs/module-doc/users_8h.html index 5170f4fbb..c26992c15 100644 --- a/docs/module-doc/users_8h.html +++ b/docs/module-doc/users_8h.html @@ -1,85 +1,88 @@ -<!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: users.h File 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>users.h File Reference</h1><code>#include "inspircd_config.h"</code><br> -<code>#include "<a class="el" href="channels_8h-source.html">channels.h</a>"</code><br> -<code>#include "<a class="el" href="connection_8h-source.html">connection.h</a>"</code><br> -<code>#include "inspstring.h"</code><br> +<!-- 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> +<div class="nav"> +<a class="el" href="dir_000000.html">home</a> » <a class="el" href="dir_000001.html">brain</a> » <a class="el" href="dir_000002.html">inspircd-cvs</a> » <a class="el" href="dir_000003.html">inspircd</a> » <a class="el" href="dir_000004.html">include</a></div> +<h1>users.h File Reference</h1><code>#include "inspircd_config.h"</code><br> +<code>#include "<a class="el" href="channels_8h-source.html">channels.h</a>"</code><br> +<code>#include "inspstring.h"</code><br> +<code>#include "<a class="el" href="connection_8h-source.html">connection.h</a>"</code><br> <code>#include <string></code><br> <p> -Include dependency graph for users.h:<p><center><img src="users_8h__incl.gif" border="0" usemap="#users.h_map" alt="Include dependency graph"></center> +Include dependency graph for users.h:<p><center><img src="users_8h__incl.gif" border="0" usemap="#users.h_map" alt=""></center> <map name="users.h_map"> -<area href="channels_8h.html" shape="rect" coords="181,82,266,109" alt=""> -<area href="connection_8h.html" shape="rect" coords="58,82,157,109" alt=""> +<area href="channels_8h-source.html" shape="rect" coords="128,108,213,135" alt=""> +<area href="connection_8h-source.html" shape="rect" coords="121,58,220,84" alt=""> </map> <p> -This graph shows which files directly or indirectly include this file:<p><center><img src="users_8h__dep__incl.gif" border="0" usemap="#users.hdep_map" alt="Included by dependency graph"></center> +This graph shows which files directly or indirectly include this file:<p><center><img src="users_8h__dep__incl.gif" border="0" usemap="#users.hdep_map" alt=""></center> <map name="users.hdep_map"> -<area href="channels_8cpp.html" shape="rect" coords="432,9,530,35" alt=""> -<area href="message_8h.html" shape="rect" coords="376,83,461,110" alt=""> -<area href="mode_8h.html" shape="rect" coords="485,83,552,110" alt=""> -<area href="xline_8h.html" shape="rect" coords="290,83,352,110" alt=""> -<area href="modules_8cpp.html" shape="rect" coords="272,9,370,35" alt=""> -<area href="commands_8h.html" shape="rect" coords="64,83,162,110" alt=""> -<area href="users_8cpp.html" shape="rect" coords="186,83,266,110" alt=""> +<area href="channels_8cpp-source.html" shape="rect" coords="269,83,368,109" alt=""> +<area href="modules_8cpp-source.html" shape="rect" coords="269,159,368,185" alt=""> +<area href="users_8cpp-source.html" shape="rect" coords="131,311,211,337" alt=""> +<area href="commands_8h-source.html" shape="rect" coords="121,209,220,236" alt=""> +<area href="message_8h-source.html" shape="rect" coords="128,57,213,84" alt=""> +<area href="mode_8h-source.html" shape="rect" coords="137,108,204,135" alt=""> +<area href="xline_8h-source.html" shape="rect" coords="140,159,201,185" alt=""> </map> <p> -<a href="users_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0> +<a href="users_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 class="memItemLeft" nowrap align=right valign=top>class </td><td class="memItemRight" valign=bottom><a class="el" href="classConnectClass.html">ConnectClass</a></td></tr> +<tr><td colspan="2"><br><h2>Classes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classInvited.html">Invited</a></td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds information relevent to <connect allow> and <connect deny> tags in the config file. </em> <a href="classConnectClass.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="classInvited.html">Invited</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds a channel name to which a user has been invited. <a href="classInvited.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classConnectClass.html">ConnectClass</a></td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds a channel name to which a user has been invited. </em> <a href="classInvited.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="classuserrec.html">userrec</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds information relevent to <connect allow> and <connect deny> tags in the config file. <a href="classConnectClass.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html">userrec</a></td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds all information about a user This class stores all information about a user connected to the irc server. </em> <a href="classuserrec.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="classWhoWasUser.html">WhoWasUser</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds all information about a user This class stores all information about a user connected to the irc server. <a href="classuserrec.html#_details">More...</a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classWhoWasUser.html">WhoWasUser</a></td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">A lightweight userrec used by WHOWAS. </em> <a href="classWhoWasUser.html#_details">More...</a><em><br><br></td></tr> -<tr><td colspan=2><br><h2>Defines</h2></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="users_8h.html#a0">STATUS_OP</a> 4</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">A lightweight userrec used by WHOWAS. <a href="classWhoWasUser.html#_details">More...</a><br></td></tr> +<tr><td colspan="2"><br><h2>Defines</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="users_8h.html#STATUS_5FOP">STATUS_OP</a> 4</td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="users_8h.html#a1">STATUS_HOP</a> 2</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="users_8h.html#STATUS_5FHOP">STATUS_HOP</a> 2</td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="users_8h.html#a2">STATUS_VOICE</a> 1</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="users_8h.html#STATUS_5FVOICE">STATUS_VOICE</a> 1</td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="users_8h.html#a3">STATUS_NORMAL</a> 0</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="users_8h.html#STATUS_5FNORMAL">STATUS_NORMAL</a> 0</td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="users_8h.html#a4">CC_ALLOW</a> 0</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="users_8h.html#CC_5FALLOW">CC_ALLOW</a> 0</td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="users_8h.html#a5">CC_DENY</a> 1</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="users_8h.html#CC_5FDENY">CC_DENY</a> 1</td></tr> -<tr><td colspan=2><br><h2>Typedefs</h2></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::vector< <a class="el" href="classInvited.html">Invited</a> > </td><td class="memItemRight" valign=bottom><a class="el" href="users_8h.html#a6">InvitedList</a></td></tr> +<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector< <a class="el" href="classInvited.html">Invited</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="users_8h.html#InvitedList">InvitedList</a></td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds a complete list of all channels to which a user has been invited and has not yet joined. </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="classConnectClass.html">ConnectClass</a> > </td><td class="memItemRight" valign=bottom><a class="el" href="users_8h.html#a7">ClassVector</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds a complete list of all channels to which a user has been invited and has not yet joined. <a href="#InvitedList"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector< <a class="el" href="classConnectClass.html">ConnectClass</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="users_8h.html#ClassVector">ClassVector</a></td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds a complete list of all allow and deny tags from the configuration file (connection classes). </em> <a href="#a7"></a><em><br><br></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds a complete list of all allow and deny tags from the configuration file (connection classes). <a href="#ClassVector"></a><br></td></tr> </table> <hr><h2>Define Documentation</h2> -<a name="a4" doxytag="users.h::CC_ALLOW"></a><p> -<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> +<a class="anchor" name="CC_5FALLOW"></a><!-- doxytag: member="users.h::CC_ALLOW" ref="CC_5FALLOW" 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"> #define CC_ALLOW 0 + <td class="md" nowrap valign="top">#define CC_ALLOW 0 </td> + </tr> </table> </td> </tr> </table> -<table cellspacing=5 cellpadding=0 border=0> +<table cellspacing="5" cellpadding="0" border="0"> <tr> <td> @@ -92,18 +95,19 @@ This graph shows which files directly or indirectly include this file:<p><center Definition at line <a class="el" href="users_8h-source.html#l00031">31</a> of file <a class="el" href="users_8h-source.html">users.h</a>. </td> </tr> </table> -<a name="a5" doxytag="users.h::CC_DENY"></a><p> -<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> +<a class="anchor" name="CC_5FDENY"></a><!-- doxytag: member="users.h::CC_DENY" ref="CC_5FDENY" 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"> #define CC_DENY 1 + <td class="md" nowrap valign="top">#define CC_DENY 1 </td> + </tr> </table> </td> </tr> </table> -<table cellspacing=5 cellpadding=0 border=0> +<table cellspacing="5" cellpadding="0" border="0"> <tr> <td> @@ -116,18 +120,19 @@ Definition at line <a class="el" href="users_8h-source.html#l00031">31</a> of fi Definition at line <a class="el" href="users_8h-source.html#l00032">32</a> of file <a class="el" href="users_8h-source.html">users.h</a>. </td> </tr> </table> -<a name="a1" doxytag="users.h::STATUS_HOP"></a><p> -<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> +<a class="anchor" name="STATUS_5FHOP"></a><!-- doxytag: member="users.h::STATUS_HOP" ref="STATUS_5FHOP" 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"> #define STATUS_HOP 2 + <td class="md" nowrap valign="top">#define STATUS_HOP 2 </td> + </tr> </table> </td> </tr> </table> -<table cellspacing=5 cellpadding=0 border=0> +<table cellspacing="5" cellpadding="0" border="0"> <tr> <td> @@ -140,18 +145,19 @@ Definition at line <a class="el" href="users_8h-source.html#l00032">32</a> of fi Definition at line <a class="el" href="users_8h-source.html#l00027">27</a> of file <a class="el" href="users_8h-source.html">users.h</a>. </td> </tr> </table> -<a name="a3" doxytag="users.h::STATUS_NORMAL"></a><p> -<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> +<a class="anchor" name="STATUS_5FNORMAL"></a><!-- doxytag: member="users.h::STATUS_NORMAL" ref="STATUS_5FNORMAL" 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"> #define STATUS_NORMAL 0 + <td class="md" nowrap valign="top">#define STATUS_NORMAL 0 </td> + </tr> </table> </td> </tr> </table> -<table cellspacing=5 cellpadding=0 border=0> +<table cellspacing="5" cellpadding="0" border="0"> <tr> <td> @@ -164,18 +170,19 @@ Definition at line <a class="el" href="users_8h-source.html#l00027">27</a> of fi Definition at line <a class="el" href="users_8h-source.html#l00029">29</a> of file <a class="el" href="users_8h-source.html">users.h</a>. </td> </tr> </table> -<a name="a0" doxytag="users.h::STATUS_OP"></a><p> -<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> +<a class="anchor" name="STATUS_5FOP"></a><!-- doxytag: member="users.h::STATUS_OP" ref="STATUS_5FOP" 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"> #define STATUS_OP 4 + <td class="md" nowrap valign="top">#define STATUS_OP 4 </td> + </tr> </table> </td> </tr> </table> -<table cellspacing=5 cellpadding=0 border=0> +<table cellspacing="5" cellpadding="0" border="0"> <tr> <td> @@ -188,18 +195,19 @@ Definition at line <a class="el" href="users_8h-source.html#l00029">29</a> of fi Definition at line <a class="el" href="users_8h-source.html#l00026">26</a> of file <a class="el" href="users_8h-source.html">users.h</a>. </td> </tr> </table> -<a name="a2" doxytag="users.h::STATUS_VOICE"></a><p> -<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> +<a class="anchor" name="STATUS_5FVOICE"></a><!-- doxytag: member="users.h::STATUS_VOICE" ref="STATUS_5FVOICE" 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"> #define STATUS_VOICE 1 + <td class="md" nowrap valign="top">#define STATUS_VOICE 1 </td> + </tr> </table> </td> </tr> </table> -<table cellspacing=5 cellpadding=0 border=0> +<table cellspacing="5" cellpadding="0" border="0"> <tr> <td> @@ -213,18 +221,19 @@ Definition at line <a class="el" href="users_8h-source.html#l00028">28</a> of fi </tr> </table> <hr><h2>Typedef Documentation</h2> -<a name="a7" doxytag="users.h::ClassVector"></a><p> -<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> +<a class="anchor" name="ClassVector"></a><!-- doxytag: member="users.h::ClassVector" ref="ClassVector" 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"> typedef std::vector<<a class="el" href="classConnectClass.html">ConnectClass</a>> <a class="el" href="users_8h.html#a7">ClassVector</a> + <td class="md" nowrap valign="top">typedef std::vector<<a class="el" href="classConnectClass.html">ConnectClass</a>> <a class="el" href="users_8h.html#ClassVector">ClassVector</a> </td> + </tr> </table> </td> </tr> </table> -<table cellspacing=5 cellpadding=0 border=0> +<table cellspacing="5" cellpadding="0" border="0"> <tr> <td> @@ -239,18 +248,19 @@ Holds a complete list of all allow and deny tags from the configuration file (co Definition at line <a class="el" href="users_8h-source.html#l00100">100</a> of file <a class="el" href="users_8h-source.html">users.h</a>. </td> </tr> </table> -<a name="a6" doxytag="users.h::InvitedList"></a><p> -<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> +<a class="anchor" name="InvitedList"></a><!-- doxytag: member="users.h::InvitedList" ref="InvitedList" 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"> typedef std::vector<<a class="el" href="classInvited.html">Invited</a>> <a class="el" href="users_8h.html#a6">InvitedList</a> + <td class="md" nowrap valign="top">typedef std::vector<<a class="el" href="classInvited.html">Invited</a>> <a class="el" href="users_8h.html#InvitedList">InvitedList</a> </td> + </tr> </table> </td> </tr> </table> -<table cellspacing=5 cellpadding=0 border=0> +<table cellspacing="5" cellpadding="0" border="0"> <tr> <td> @@ -262,14 +272,11 @@ Holds a complete list of all channels to which a user has been invited and has n <p> <p> -Definition at line <a class="el" href="users_8h-source.html#l00094">94</a> of file <a class="el" href="users_8h-source.html">users.h</a>. -<p> -Referenced by <a class="el" href="users_8cpp-source.html#l00106">userrec::GetInviteList()</a>. </td> +Definition at line <a class="el" href="users_8h-source.html#l00094">94</a> of file <a class="el" href="users_8h-source.html">users.h</a>. </td> </tr> </table> -<hr size="1"><address style="align: right;"><small>Generated on Mon May 30 05:16:19 2005 for InspIRCd by +<hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:24 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> |