Modified documentation for base classes

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

1 files changed, 78 insertions, 107 deletions

diff --git a/docs/module-doc/users_8h-source.html b/docs/module-doc/users_8h-source.html
index 966673141..9557b4d0a 100644
--- a/docs/module-doc/users_8h-source.html
+++ b/docs/module-doc/users_8h-source.html
@@ -9,8 +9,8 @@
 <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.2  2003/01/23 20:38:00  brain
-00003 <span class="comment">Updated documentation scripts
+00003 <span class="comment">Revision 1.3  2003/01/26 23:52:48  brain
+00003 <span class="comment">Modified documentation for base classes
 00003 <span class="comment"></span>
 00004 <span class="comment">Revision 1.1.1.1  2003/01/23 19:45:58  brain</span>
 00005 <span class="comment">InspIRCd second source tree</span>
@@ -42,115 +42,86 @@
 00031 
 00032 <span class="preprocessor">#include "inspircd_config.h"</span> 
 00033 <span class="preprocessor">#include "<a class="code" href="channels_8h.html">channels.h</a>"</span>
-00034 
-00035 <span class="preprocessor">#include &lt;string&gt;</span>
-00036  
-00037 <span class="preprocessor">#ifndef __USERS_H__ </span>
-00038 <span class="preprocessor"></span><span class="preprocessor">#define __USERS_H__ </span>
-00039 <span class="preprocessor"></span> 
-<a name="l00040"></a><a class="code" href="users_8h.html#a0">00040</a> <span class="preprocessor">#define STATUS_OP       4</span>
-<a name="l00041"></a><a class="code" href="users_8h.html#a1">00041</a> <span class="preprocessor"></span><span class="preprocessor">#define STATUS_HOP      2</span>
-<a name="l00042"></a><a class="code" href="users_8h.html#a2">00042</a> <span class="preprocessor"></span><span class="preprocessor">#define STATUS_VOICE    1</span>
-<a name="l00043"></a><a class="code" href="users_8h.html#a3">00043</a> <span class="preprocessor"></span><span class="preprocessor">#define STATUS_NORMAL   0</span>
-00044 <span class="preprocessor"></span>
-<a name="l00045"></a><a class="code" href="users_8h.html#a4">00045</a> <span class="preprocessor">#define CC_ALLOW        0</span>
-<a name="l00046"></a><a class="code" href="users_8h.html#a5">00046</a> <span class="preprocessor"></span><span class="preprocessor">#define CC_DENY         1</span>
-00047 <span class="preprocessor"></span>
-<a name="l00050"></a><a class="code" href="classInvited.html">00050</a> <span class="keyword">class </span><a class="code" href="classInvited.html">Invited</a>
-00051 {
-00052  <span class="keyword">public</span>:
-<a name="l00053"></a><a class="code" href="classInvited.html#m0">00053</a>         <span class="keywordtype">char</span> <a class="code" href="classInvited.html#m0">channel</a>[CHANMAX];
-00054 };
-00055 
+00034 <span class="preprocessor">#include "<a class="code" href="connection_8h.html">connection.h</a>"</span>
+00035 
+00036 <span class="preprocessor">#include &lt;string&gt;</span>
+00037  
+00038 <span class="preprocessor">#ifndef __USERS_H__ </span>
+00039 <span class="preprocessor"></span><span class="preprocessor">#define __USERS_H__ </span>
+00040 <span class="preprocessor"></span> 
+<a name="l00041"></a><a class="code" href="users_8h.html#a0">00041</a> <span class="preprocessor">#define STATUS_OP       4</span>
+<a name="l00042"></a><a class="code" href="users_8h.html#a1">00042</a> <span class="preprocessor"></span><span class="preprocessor">#define STATUS_HOP      2</span>
+<a name="l00043"></a><a class="code" href="users_8h.html#a2">00043</a> <span class="preprocessor"></span><span class="preprocessor">#define STATUS_VOICE    1</span>
+<a name="l00044"></a><a class="code" href="users_8h.html#a3">00044</a> <span class="preprocessor"></span><span class="preprocessor">#define STATUS_NORMAL   0</span>
+00045 <span class="preprocessor"></span>
+<a name="l00046"></a><a class="code" href="users_8h.html#a4">00046</a> <span class="preprocessor">#define CC_ALLOW        0</span>
+<a name="l00047"></a><a class="code" href="users_8h.html#a5">00047</a> <span class="preprocessor"></span><span class="preprocessor">#define CC_DENY         1</span>
+00048 <span class="preprocessor"></span>
+<a name="l00051"></a><a class="code" href="classInvited.html">00051</a> <span class="keyword">class </span><a class="code" href="classInvited.html">Invited</a>
+00052 {
+00053  <span class="keyword">public</span>:
+<a name="l00054"></a><a class="code" href="classInvited.html#m0">00054</a>         <span class="keywordtype">char</span> <a class="code" href="classInvited.html#m0">channel</a>[CHANMAX];
+00055 };
 00056 
-<a name="l00059"></a><a class="code" href="classConnectClass.html">00059</a> <span class="keyword">class </span><a class="code" href="classConnectClass.html">ConnectClass</a>
-00060 {
-00061  <span class="keyword">public</span>:
-<a name="l00062"></a><a class="code" href="classConnectClass.html#m0">00062</a>         <span class="keywordtype">int</span> <a class="code" href="classConnectClass.html#m0">type</a>;
-<a name="l00063"></a><a class="code" href="classConnectClass.html#m1">00063</a>         <span class="keywordtype">char</span> <a class="code" href="classConnectClass.html#m1">host</a>[MAXBUF];
-<a name="l00064"></a><a class="code" href="classConnectClass.html#m2">00064</a>         <span class="keywordtype">char</span> <a class="code" href="classConnectClass.html#m2">pass</a>[MAXBUF];
-00065 };
-00066 
-<a name="l00069"></a><a class="code" href="users_8h.html#a6">00069</a> <span class="keyword">typedef</span> vector&lt;Invited&gt; <a class="code" href="users_8h.html#a6">InvitedList</a>;
-00070 
+00057 
+<a name="l00060"></a><a class="code" href="classConnectClass.html">00060</a> <span class="keyword">class </span><a class="code" href="classConnectClass.html">ConnectClass</a>
+00061 {
+00062  <span class="keyword">public</span>:
+<a name="l00063"></a><a class="code" href="classConnectClass.html#m0">00063</a>         <span class="keywordtype">int</span> <a class="code" href="classConnectClass.html#m0">type</a>;
+<a name="l00064"></a><a class="code" href="classConnectClass.html#m1">00064</a>         <span class="keywordtype">char</span> <a class="code" href="classConnectClass.html#m1">host</a>[MAXBUF];
+<a name="l00065"></a><a class="code" href="classConnectClass.html#m2">00065</a>         <span class="keywordtype">char</span> <a class="code" href="classConnectClass.html#m2">pass</a>[MAXBUF];
+00066 };
+00067 
+<a name="l00070"></a><a class="code" href="users_8h.html#a6">00070</a> <span class="keyword">typedef</span> vector&lt;Invited&gt; <a class="code" href="users_8h.html#a6">InvitedList</a>;
 00071 
 00072 
-<a name="l00075"></a><a class="code" href="users_8h.html#a7">00075</a> <span class="keyword">typedef</span> vector&lt;ConnectClass&gt; <a class="code" href="users_8h.html#a7">ClassVector</a>;
-00076 
-<a name="l00083"></a><a class="code" href="classuserrec.html">00083</a> <span class="keyword">class </span><a class="code" href="classuserrec.html">userrec</a>
-00084 {
-00085  <span class="keyword">private</span>:
-00086 
-<a name="l00089"></a><a class="code" href="classuserrec.html#o0">00089</a>         <a class="code" href="users_8h.html#a6">InvitedList</a> <a class="code" href="classuserrec.html#o0">invites</a>;
-00090  <span class="keyword">public</span>:
-00091         
-<a name="l00096"></a><a class="code" href="classuserrec.html#m0">00096</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m0">nick</a>[NICKMAX];
-00097         
-<a name="l00100"></a><a class="code" href="classuserrec.html#m1">00100</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classuserrec.html#m1">ip</a>;
-00101 
-<a name="l00104"></a><a class="code" href="classuserrec.html#m2">00104</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m2">ident</a>[64];
-00105 
-<a name="l00108"></a><a class="code" href="classuserrec.html#m3">00108</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m3">host</a>[256];
-00109         
-<a name="l00113"></a><a class="code" href="classuserrec.html#m4">00113</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m4">dhost</a>[256];
-00114         
-<a name="l00117"></a><a class="code" href="classuserrec.html#m5">00117</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m5">fullname</a>[128];
-00118         
-<a name="l00123"></a><a class="code" href="classuserrec.html#m6">00123</a>         <span class="keywordtype">int</span> <a class="code" href="classuserrec.html#m6">fd</a>;
-00124         
-<a name="l00129"></a><a class="code" href="classuserrec.html#m7">00129</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m7">modes</a>[32];
-00130         
-<a name="l00134"></a><a class="code" href="classuserrec.html#m8">00134</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m8">inbuf</a>[MAXBUF];
+00073 
+<a name="l00076"></a><a class="code" href="users_8h.html#a7">00076</a> <span class="keyword">typedef</span> vector&lt;ConnectClass&gt; <a class="code" href="users_8h.html#a7">ClassVector</a>;
+00077 
+<a name="l00084"></a><a class="code" href="classuserrec.html">00084</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>
+00085 {
+00086  <span class="keyword">private</span>:
+00087 
+<a name="l00090"></a><a class="code" href="classuserrec.html#o0">00090</a>         <a class="code" href="users_8h.html#a6">InvitedList</a> <a class="code" href="classuserrec.html#o0">invites</a>;
+00091  <span class="keyword">public</span>:
+00092         
+<a name="l00097"></a><a class="code" href="classuserrec.html#m0">00097</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m0">nick</a>[NICKMAX];
+00098         
+<a name="l00101"></a><a class="code" href="classuserrec.html#m1">00101</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m1">ident</a>[64];
+00102 
+<a name="l00106"></a><a class="code" href="classuserrec.html#m2">00106</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m2">dhost</a>[256];
+00107         
+<a name="l00110"></a><a class="code" href="classuserrec.html#m3">00110</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m3">fullname</a>[128];
+00111         
+<a name="l00116"></a><a class="code" href="classuserrec.html#m4">00116</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m4">modes</a>[32];
+00117         
+<a name="l00118"></a><a class="code" href="classuserrec.html#m5">00118</a>         <a class="code" href="classucrec.html">ucrec</a> <a class="code" href="classuserrec.html#m5">chans</a>[MAXCHANS];
+00119         
+<a name="l00122"></a><a class="code" href="classuserrec.html#m6">00122</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m6">server</a>[256];
+00123         
+<a name="l00127"></a><a class="code" href="classuserrec.html#m7">00127</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m7">awaymsg</a>[512];
+00128         
+<a name="l00132"></a><a class="code" href="classuserrec.html#m8">00132</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m8">result</a>[256];
+00133         
+00134         <a class="code" href="classuserrec.html#a0">userrec</a>();
 00135         
-<a name="l00141"></a><a class="code" href="classuserrec.html#m9">00141</a>         time_t <a class="code" href="classuserrec.html#m9">lastping</a>;
-00142         
-<a name="l00145"></a><a class="code" href="classuserrec.html#m10">00145</a>         time_t <a class="code" href="classuserrec.html#m10">signon</a>;
-00146         
-<a name="l00150"></a><a class="code" href="classuserrec.html#m11">00150</a>         time_t <a class="code" href="classuserrec.html#m11">idle_lastmsg</a>;
-00151         
-<a name="l00156"></a><a class="code" href="classuserrec.html#m12">00156</a>         time_t <a class="code" href="classuserrec.html#m12">nping</a>;
-00157         
-<a name="l00162"></a><a class="code" href="classuserrec.html#m13">00162</a>         <span class="keywordtype">int</span> <a class="code" href="classuserrec.html#m13">registered</a>;
-00163         
-<a name="l00168"></a><a class="code" href="classuserrec.html#m14">00168</a>         <a class="code" href="classucrec.html">ucrec</a> <a class="code" href="classuserrec.html#m14">chans</a>[MAXCHANS];
-00169         
-<a name="l00172"></a><a class="code" href="classuserrec.html#m15">00172</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m15">server</a>[256];
-00173         
-<a name="l00177"></a><a class="code" href="classuserrec.html#m16">00177</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m16">awaymsg</a>[512];
-00178         
-<a name="l00181"></a><a class="code" href="classuserrec.html#m17">00181</a>         <span class="keywordtype">int</span> <a class="code" href="classuserrec.html#m17">port</a>;
-00182         
-<a name="l00186"></a><a class="code" href="classuserrec.html#m18">00186</a>         <span class="keywordtype">long</span> <a class="code" href="classuserrec.html#m18">bytes_in</a>;
-00187         
-<a name="l00191"></a><a class="code" href="classuserrec.html#m19">00191</a>         <span class="keywordtype">long</span> <a class="code" href="classuserrec.html#m19">bytes_out</a>;
-00192         
-<a name="l00196"></a><a class="code" href="classuserrec.html#m20">00196</a>         <span class="keywordtype">long</span> <a class="code" href="classuserrec.html#m20">cmds_in</a>;
-00197         
-<a name="l00201"></a><a class="code" href="classuserrec.html#m21">00201</a>         <span class="keywordtype">long</span> <a class="code" href="classuserrec.html#m21">cmds_out</a>;
-00202         
-<a name="l00206"></a><a class="code" href="classuserrec.html#m22">00206</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m22">result</a>[256];
-00207         
-<a name="l00212"></a><a class="code" href="classuserrec.html#m23">00212</a>         <span class="keywordtype">bool</span> <a class="code" href="classuserrec.html#m23">haspassed</a>;
-00213 
-00214         <a class="code" href="classuserrec.html#a0">userrec</a>();
-00215         
-<a name="l00216"></a><a class="code" href="classuserrec.html#a1">00216</a>         <span class="keyword">virtual</span> <a class="code" href="classuserrec.html#a1">~userrec</a>() {  }
-00217         
-00222         <span class="keyword">virtual</span> <span class="keywordtype">char</span>* <a class="code" href="classuserrec.html#a2">GetFullHost</a>();
-00223         
-00229         <span class="keyword">virtual</span> <span class="keywordtype">char</span>* <a class="code" href="classuserrec.html#a3">GetFullRealHost</a>();
-00230         
-00233         <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);
-00234         
-00237         <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);
-00238         
-00243         <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);
-00244         
-00245 };
-00246 
-00247 
-00248 <span class="preprocessor">#endif</span>
-</pre></div><hr><address style="align: right;"><small>Generated on Thu Jan 23 20:28:58 2003 for InspIRCd by
+<a name="l00136"></a><a class="code" href="classuserrec.html#a1">00136</a>         <span class="keyword">virtual</span> <a class="code" href="classuserrec.html#a1">~userrec</a>() {  }
+00137         
+00142         <span class="keyword">virtual</span> <span class="keywordtype">char</span>* <a class="code" href="classuserrec.html#a2">GetFullHost</a>();
+00143         
+00149         <span class="keyword">virtual</span> <span class="keywordtype">char</span>* <a class="code" href="classuserrec.html#a3">GetFullRealHost</a>();
+00150         
+00153         <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);
+00154         
+00157         <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);
+00158         
+00163         <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);
+00164         
+00165 };
+00166 
+00167 
+00168 <span class="preprocessor">#endif</span>
+</pre></div><hr><address style="align: right;"><small>Generated on Sun Jan 26 23:45:48 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>