Documentation update, 09/02/03

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@167 e03df62e-2008-0410-955e-edbf42e46eb7

1 files changed, 84 insertions, 121 deletions

diff --git a/docs/module-doc/users_8h-source.html b/docs/module-doc/users_8h-source.html
index e923929aa..6bb848a39 100644
--- a/docs/module-doc/users_8h-source.html
+++ b/docs/module-doc/users_8h-source.html
@@ -8,128 +8,91 @@
 <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>users.h</h1><a href="users_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*</span>
 00002 <span class="comment"></span>
-00003 <span class="comment">$Log$
-00003 <span class="comment">Revision 1.5  2003/01/27 00:28:57  brain
-00003 <span class="comment">...
 00003 <span class="comment"></span>
-00004 <span class="comment">Revision 1.3  2003/01/27 00:22:53  brain</span>
-00005 <span class="comment">Modified documentation</span>
-00006 <span class="comment">Moved some classes below base class</span>
-00007 <span class="comment"></span>
-00008 <span class="comment">Revision 1.2  2003/01/26 23:52:59  brain</span>
-00009 <span class="comment">Modified documentation for base classes</span>
-00010 <span class="comment">Added base classes</span>
-00011 <span class="comment"></span>
-00012 <span class="comment">Revision 1.1.1.1  2003/01/23 19:45:58  brain</span>
-00013 <span class="comment">InspIRCd second source tree</span>
-00014 <span class="comment"></span>
-00015 <span class="comment">Revision 1.9  2003/01/22 00:44:26  brain</span>
-00016 <span class="comment">Added documentation comments</span>
-00017 <span class="comment"></span>
-00018 <span class="comment">Revision 1.8  2003/01/21 21:11:17  brain</span>
-00019 <span class="comment">Added documentation</span>
-00020 <span class="comment"></span>
-00021 <span class="comment">Revision 1.7  2003/01/17 13:21:38  brain</span>
-00022 <span class="comment">Added CONNECT ALLOW and CONNECT DENY config tags</span>
-00023 <span class="comment">Added PASS command</span>
-00024 <span class="comment"></span>
-00025 <span class="comment">Revision 1.6  2003/01/17 10:37:55  brain</span>
-00026 <span class="comment">Added /INVITE command and relevent structures</span>
-00027 <span class="comment"></span>
-00028 <span class="comment">Revision 1.5  2003/01/16 20:11:56  brain</span>
-00029 <span class="comment">fixed some ugly pointer bugs (thanks dblack and a|KK|y!)</span>
-00030 <span class="comment"></span>
-00031 <span class="comment">Revision 1.4  2003/01/15 22:47:44  brain</span>
-00032 <span class="comment">Changed user and channel structs to classes (finally)</span>
-00033 <span class="comment"></span>
-00034 <span class="comment">Revision 1.3  2003/01/14 21:14:30  brain</span>
-00035 <span class="comment">added /ISON command (for mIRC etc basic notify)</span>
-00036 <span class="comment"></span>
-00037 <span class="comment"></span>
-00038 <span class="comment">*/</span>
-00039 
-00040 <span class="preprocessor">#include "inspircd_config.h"</span> 
-00041 <span class="preprocessor">#include "<a class="code" href="channels_8h.html">channels.h</a>"</span>
-00042 <span class="preprocessor">#include "<a class="code" href="connection_8h.html">connection.h</a>"</span>
-00043 
-00044 <span class="preprocessor">#include &lt;string&gt;</span>
-00045  
-00046 <span class="preprocessor">#ifndef __USERS_H__ </span>
-00047 <span class="preprocessor"></span><span class="preprocessor">#define __USERS_H__ </span>
-00048 <span class="preprocessor"></span> 
-<a name="l00049"></a><a class="code" href="users_8h.html#a0">00049</a> <span class="preprocessor">#define STATUS_OP       4</span>
-<a name="l00050"></a><a class="code" href="users_8h.html#a1">00050</a> <span class="preprocessor"></span><span class="preprocessor">#define STATUS_HOP      2</span>
-<a name="l00051"></a><a class="code" href="users_8h.html#a2">00051</a> <span class="preprocessor"></span><span class="preprocessor">#define STATUS_VOICE    1</span>
-<a name="l00052"></a><a class="code" href="users_8h.html#a3">00052</a> <span class="preprocessor"></span><span class="preprocessor">#define STATUS_NORMAL   0</span>
-00053 <span class="preprocessor"></span>
-<a name="l00054"></a><a class="code" href="users_8h.html#a4">00054</a> <span class="preprocessor">#define CC_ALLOW        0</span>
-<a name="l00055"></a><a class="code" href="users_8h.html#a5">00055</a> <span class="preprocessor"></span><span class="preprocessor">#define CC_DENY         1</span>
-00056 <span class="preprocessor"></span>
-<a name="l00059"></a><a class="code" href="classInvited.html">00059</a> <span class="keyword">class </span><a class="code" href="classInvited.html">Invited</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a>
-00060 {
-00061  <span class="keyword">public</span>:
-<a name="l00062"></a><a class="code" href="classInvited.html#m0">00062</a>         <span class="keywordtype">char</span> <a class="code" href="classInvited.html#m0">channel</a>[CHANMAX];
-00063 };
-00064 
-00065 
-<a name="l00068"></a><a class="code" href="classConnectClass.html">00068</a> <span class="keyword">class </span><a class="code" href="classConnectClass.html">ConnectClass</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a>
-00069 {
-00070  <span class="keyword">public</span>:
-<a name="l00071"></a><a class="code" href="classConnectClass.html#m0">00071</a>         <span class="keywordtype">int</span> <a class="code" href="classConnectClass.html#m0">type</a>;
-<a name="l00072"></a><a class="code" href="classConnectClass.html#m1">00072</a>         <span class="keywordtype">char</span> <a class="code" href="classConnectClass.html#m1">host</a>[MAXBUF];
-<a name="l00073"></a><a class="code" href="classConnectClass.html#m2">00073</a>         <span class="keywordtype">char</span> <a class="code" href="classConnectClass.html#m2">pass</a>[MAXBUF];
-00074 };
-00075 
-<a name="l00078"></a><a class="code" href="users_8h.html#a6">00078</a> <span class="keyword">typedef</span> vector&lt;Invited&gt; <a class="code" href="users_8h.html#a6">InvitedList</a>;
-00079 
-00080 
-00081 
-<a name="l00084"></a><a class="code" href="users_8h.html#a7">00084</a> <span class="keyword">typedef</span> vector&lt;ConnectClass&gt; <a class="code" href="users_8h.html#a7">ClassVector</a>;
-00085 
-<a name="l00092"></a><a class="code" href="classuserrec.html">00092</a> <span class="keyword">class </span><a class="code" href="classuserrec.html">userrec</a> : <span class="keyword">public</span> <a class="code" href="classconnection.html">connection</a>
-00093 {
-00094  <span class="keyword">private</span>:
-00095 
-<a name="l00098"></a><a class="code" href="classuserrec.html#o0">00098</a>         <a class="code" href="users_8h.html#a6">InvitedList</a> <a class="code" href="classuserrec.html#o0">invites</a>;
-00099  <span class="keyword">public</span>:
-00100         
-<a name="l00105"></a><a class="code" href="classuserrec.html#m0">00105</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m0">nick</a>[NICKMAX];
-00106         
-<a name="l00109"></a><a class="code" href="classuserrec.html#m1">00109</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m1">ident</a>[64];
-00110 
-<a name="l00114"></a><a class="code" href="classuserrec.html#m2">00114</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m2">dhost</a>[256];
-00115         
-<a name="l00118"></a><a class="code" href="classuserrec.html#m3">00118</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m3">fullname</a>[128];
-00119         
-<a name="l00124"></a><a class="code" href="classuserrec.html#m4">00124</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m4">modes</a>[32];
-00125         
-<a name="l00126"></a><a class="code" href="classuserrec.html#m5">00126</a>         <a class="code" href="classucrec.html">ucrec</a> <a class="code" href="classuserrec.html#m5">chans</a>[MAXCHANS];
-00127         
-<a name="l00130"></a><a class="code" href="classuserrec.html#m6">00130</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m6">server</a>[256];
-00131         
-<a name="l00135"></a><a class="code" href="classuserrec.html#m7">00135</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m7">awaymsg</a>[512];
-00136         
-<a name="l00140"></a><a class="code" href="classuserrec.html#m8">00140</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m8">result</a>[256];
-00141         
-00142         <a class="code" href="classuserrec.html#a0">userrec</a>();
-00143         
-<a name="l00144"></a><a class="code" href="classuserrec.html#a1">00144</a>         <span class="keyword">virtual</span> <a class="code" href="classuserrec.html#a1">~userrec</a>() {  }
-00145         
-00150         <span class="keyword">virtual</span> <span class="keywordtype">char</span>* <a class="code" href="classuserrec.html#a2">GetFullHost</a>();
-00151         
-00157         <span class="keyword">virtual</span> <span class="keywordtype">char</span>* <a class="code" href="classuserrec.html#a3">GetFullRealHost</a>();
-00158         
-00161         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classuserrec.html#a4">IsInvited</a>(<span class="keywordtype">char</span>* channel);
-00162         
-00165         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classuserrec.html#a5">InviteTo</a>(<span class="keywordtype">char</span>* channel);
-00166         
-00171         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classuserrec.html#a6">RemoveInvite</a>(<span class="keywordtype">char</span>* channel);
-00172         
-00173 };
-00174 
-00175 
-00176 <span class="preprocessor">#endif</span>
-</pre></div><hr><address style="align: right;"><small>Generated on Mon Jan 27 00:23:11 2003 for InspIRCd by
+00004 <span class="comment">*/</span>
+00005 
+00006 <span class="preprocessor">#include "inspircd_config.h"</span> 
+00007 <span class="preprocessor">#include "<a class="code" href="channels_8h.html">channels.h</a>"</span>
+00008 <span class="preprocessor">#include "<a class="code" href="connection_8h.html">connection.h</a>"</span>
+00009 
+00010 <span class="preprocessor">#include &lt;string&gt;</span>
+00011  
+00012 <span class="preprocessor">#ifndef __USERS_H__ </span>
+00013 <span class="preprocessor"></span><span class="preprocessor">#define __USERS_H__ </span>
+00014 <span class="preprocessor"></span> 
+<a name="l00015"></a><a class="code" href="users_8h.html#a0">00015</a> <span class="preprocessor">#define STATUS_OP       4</span>
+<a name="l00016"></a><a class="code" href="users_8h.html#a1">00016</a> <span class="preprocessor"></span><span class="preprocessor">#define STATUS_HOP      2</span>
+<a name="l00017"></a><a class="code" href="users_8h.html#a2">00017</a> <span class="preprocessor"></span><span class="preprocessor">#define STATUS_VOICE    1</span>
+<a name="l00018"></a><a class="code" href="users_8h.html#a3">00018</a> <span class="preprocessor"></span><span class="preprocessor">#define STATUS_NORMAL   0</span>
+00019 <span class="preprocessor"></span>
+<a name="l00020"></a><a class="code" href="users_8h.html#a4">00020</a> <span class="preprocessor">#define CC_ALLOW        0</span>
+<a name="l00021"></a><a class="code" href="users_8h.html#a5">00021</a> <span class="preprocessor"></span><span class="preprocessor">#define CC_DENY         1</span>
+00022 <span class="preprocessor"></span>
+<a name="l00025"></a><a class="code" href="classInvited.html">00025</a> <span class="keyword">class </span><a class="code" href="classInvited.html">Invited</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a>
+00026 {
+00027  <span class="keyword">public</span>:
+<a name="l00028"></a><a class="code" href="classInvited.html#m0">00028</a>         <span class="keywordtype">char</span> <a class="code" href="classInvited.html#m0">channel</a>[CHANMAX];
+00029 };
+00030 
+00031 
+<a name="l00034"></a><a class="code" href="classConnectClass.html">00034</a> <span class="keyword">class </span><a class="code" href="classConnectClass.html">ConnectClass</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a>
+00035 {
+00036  <span class="keyword">public</span>:
+<a name="l00037"></a><a class="code" href="classConnectClass.html#m0">00037</a>         <span class="keywordtype">int</span> <a class="code" href="classConnectClass.html#m0">type</a>;
+<a name="l00038"></a><a class="code" href="classConnectClass.html#m1">00038</a>         <span class="keywordtype">char</span> <a class="code" href="classConnectClass.html#m1">host</a>[MAXBUF];
+<a name="l00039"></a><a class="code" href="classConnectClass.html#m2">00039</a>         <span class="keywordtype">char</span> <a class="code" href="classConnectClass.html#m2">pass</a>[MAXBUF];
+00040 };
+00041 
+<a name="l00044"></a><a class="code" href="users_8h.html#a6">00044</a> <span class="keyword">typedef</span> vector&lt;Invited&gt; <a class="code" href="users_8h.html#a6">InvitedList</a>;
+00045 
+00046 
+00047 
+<a name="l00050"></a><a class="code" href="users_8h.html#a7">00050</a> <span class="keyword">typedef</span> vector&lt;ConnectClass&gt; <a class="code" href="users_8h.html#a7">ClassVector</a>;
+00051 
+<a name="l00058"></a><a class="code" href="classuserrec.html">00058</a> <span class="keyword">class </span><a class="code" href="classuserrec.html">userrec</a> : <span class="keyword">public</span> <a class="code" href="classconnection.html">connection</a>
+00059 {
+00060  <span class="keyword">private</span>:
+00061 
+<a name="l00064"></a><a class="code" href="classuserrec.html#o0">00064</a>         <a class="code" href="users_8h.html#a6">InvitedList</a> <a class="code" href="classuserrec.html#o0">invites</a>;
+00065  <span class="keyword">public</span>:
+00066         
+<a name="l00071"></a><a class="code" href="classuserrec.html#m0">00071</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m0">nick</a>[NICKMAX];
+00072         
+<a name="l00075"></a><a class="code" href="classuserrec.html#m1">00075</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m1">ident</a>[64];
+00076 
+<a name="l00080"></a><a class="code" href="classuserrec.html#m2">00080</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m2">dhost</a>[256];
+00081         
+<a name="l00084"></a><a class="code" href="classuserrec.html#m3">00084</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m3">fullname</a>[128];
+00085         
+<a name="l00090"></a><a class="code" href="classuserrec.html#m4">00090</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m4">modes</a>[32];
+00091         
+<a name="l00092"></a><a class="code" href="classuserrec.html#m5">00092</a>         <a class="code" href="classucrec.html">ucrec</a> <a class="code" href="classuserrec.html#m5">chans</a>[MAXCHANS];
+00093         
+<a name="l00096"></a><a class="code" href="classuserrec.html#m6">00096</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m6">server</a>[256];
+00097         
+<a name="l00101"></a><a class="code" href="classuserrec.html#m7">00101</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m7">awaymsg</a>[512];
+00102         
+<a name="l00106"></a><a class="code" href="classuserrec.html#m8">00106</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m8">result</a>[256];
+00107         
+00108         <a class="code" href="classuserrec.html#a0">userrec</a>();
+00109         
+<a name="l00110"></a><a class="code" href="classuserrec.html#a1">00110</a>         <span class="keyword">virtual</span> <a class="code" href="classuserrec.html#a1">~userrec</a>() {  }
+00111         
+00116         <span class="keyword">virtual</span> <span class="keywordtype">char</span>* <a class="code" href="classuserrec.html#a2">GetFullHost</a>();
+00117         
+00123         <span class="keyword">virtual</span> <span class="keywordtype">char</span>* <a class="code" href="classuserrec.html#a3">GetFullRealHost</a>();
+00124         
+00127         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classuserrec.html#a4">IsInvited</a>(<span class="keywordtype">char</span>* channel);
+00128         
+00131         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classuserrec.html#a5">InviteTo</a>(<span class="keywordtype">char</span>* channel);
+00132         
+00137         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classuserrec.html#a6">RemoveInvite</a>(<span class="keywordtype">char</span>* channel);
+00138         
+00139 };
+00140 
+00141 
+00142 <span class="preprocessor">#endif</span>
+</pre></div><hr><address style="align: right;"><small>Generated on Sun Feb 9 12:48:16 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>