Added new documentation to cover ircd_connector

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

1 files changed, 66 insertions, 64 deletions

diff --git a/docs/module-doc/users_8h-source.html b/docs/module-doc/users_8h-source.html
index 05c0fb657..666c0a7c5 100644
--- a/docs/module-doc/users_8h-source.html
+++ b/docs/module-doc/users_8h-source.html
@@ -38,73 +38,75 @@
 <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">int</span> <a class="code" href="classConnectClass.html#m1">registration_timeout</a>;
-<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">host</a>[MAXBUF];
-<a name="l00040"></a><a class="code" href="classConnectClass.html#m3">00040</a>         <span class="keywordtype">char</span> <a class="code" href="classConnectClass.html#m3">pass</a>[MAXBUF];
-00041         
-<a name="l00042"></a><a class="code" href="classConnectClass.html#a0">00042</a>         <a class="code" href="classConnectClass.html#a0">ConnectClass</a>()
-00043         {
-00044                 registration_timeout = 0;
-00045                 strcpy(host,<span class="stringliteral">""</span>);
-00046                 strcpy(pass,<span class="stringliteral">""</span>);
-00047         }
-00048 };
-00049 
-<a name="l00052"></a><a class="code" href="users_8h.html#a6">00052</a> <span class="keyword">typedef</span> std::vector&lt;Invited&gt; <a class="code" href="users_8h.html#a6">InvitedList</a>;
-00053 
-00054 
-00055 
-<a name="l00058"></a><a class="code" href="users_8h.html#a7">00058</a> <span class="keyword">typedef</span> std::vector&lt;ConnectClass&gt; <a class="code" href="users_8h.html#a7">ClassVector</a>;
-00059 
-<a name="l00066"></a><a class="code" href="classuserrec.html">00066</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>
-00067 {
-00068  <span class="keyword">private</span>:
-00069 
-<a name="l00072"></a><a class="code" href="classuserrec.html#o0">00072</a>         <a class="code" href="users_8h.html#a6">InvitedList</a> <a class="code" href="classuserrec.html#o0">invites</a>;
-00073  <span class="keyword">public</span>:
-00074         
-<a name="l00079"></a><a class="code" href="classuserrec.html#m0">00079</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m0">nick</a>[NICKMAX];
-00080         
-<a name="l00083"></a><a class="code" href="classuserrec.html#m1">00083</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m1">ident</a>[64];
-00084 
-<a name="l00088"></a><a class="code" href="classuserrec.html#m2">00088</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m2">dhost</a>[256];
-00089         
-<a name="l00092"></a><a class="code" href="classuserrec.html#m3">00092</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m3">fullname</a>[128];
-00093         
-<a name="l00098"></a><a class="code" href="classuserrec.html#m4">00098</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m4">modes</a>[MAXBUF];
-00099         
-<a name="l00100"></a><a class="code" href="classuserrec.html#m5">00100</a>         <a class="code" href="classucrec.html">ucrec</a> <a class="code" href="classuserrec.html#m5">chans</a>[MAXCHANS];
+<a name="l00039"></a><a class="code" href="classConnectClass.html#m0">00039</a>         <span class="keywordtype">int</span> <a class="code" href="classConnectClass.html#m0">type</a>;
+<a name="l00042"></a><a class="code" href="classConnectClass.html#m1">00042</a>         <span class="keywordtype">int</span> <a class="code" href="classConnectClass.html#m1">registration_timeout</a>;
+<a name="l00045"></a><a class="code" href="classConnectClass.html#m2">00045</a>         <span class="keywordtype">int</span> <a class="code" href="classConnectClass.html#m2">flood</a>;
+<a name="l00048"></a><a class="code" href="classConnectClass.html#m3">00048</a>         <span class="keywordtype">char</span> <a class="code" href="classConnectClass.html#m3">host</a>[MAXBUF];
+<a name="l00051"></a><a class="code" href="classConnectClass.html#m4">00051</a>         <span class="keywordtype">char</span> <a class="code" href="classConnectClass.html#m4">pass</a>[MAXBUF];
+00052         
+<a name="l00053"></a><a class="code" href="classConnectClass.html#a0">00053</a>         <a class="code" href="classConnectClass.html#a0">ConnectClass</a>()
+00054         {
+00055                 registration_timeout = 0;
+00056                 flood = 0;
+00057                 strcpy(host,<span class="stringliteral">""</span>);
+00058                 strcpy(pass,<span class="stringliteral">""</span>);
+00059         }
+00060 };
+00061 
+<a name="l00064"></a><a class="code" href="users_8h.html#a6">00064</a> <span class="keyword">typedef</span> std::vector&lt;Invited&gt; <a class="code" href="users_8h.html#a6">InvitedList</a>;
+00065 
+00066 
+00067 
+<a name="l00070"></a><a class="code" href="users_8h.html#a7">00070</a> <span class="keyword">typedef</span> std::vector&lt;ConnectClass&gt; <a class="code" href="users_8h.html#a7">ClassVector</a>;
+00071 
+<a name="l00078"></a><a class="code" href="classuserrec.html">00078</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>
+00079 {
+00080  <span class="keyword">private</span>:
+00081 
+<a name="l00084"></a><a class="code" href="classuserrec.html#o0">00084</a>         <a class="code" href="users_8h.html#a6">InvitedList</a> <a class="code" href="classuserrec.html#o0">invites</a>;
+00085  <span class="keyword">public</span>:
+00086         
+<a name="l00091"></a><a class="code" href="classuserrec.html#m0">00091</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m0">nick</a>[NICKMAX];
+00092         
+<a name="l00095"></a><a class="code" href="classuserrec.html#m1">00095</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m1">ident</a>[64];
+00096 
+<a name="l00100"></a><a class="code" href="classuserrec.html#m2">00100</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m2">dhost</a>[256];
 00101         
-<a name="l00104"></a><a class="code" href="classuserrec.html#m6">00104</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m6">server</a>[256];
+<a name="l00104"></a><a class="code" href="classuserrec.html#m3">00104</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m3">fullname</a>[128];
 00105         
-<a name="l00109"></a><a class="code" href="classuserrec.html#m7">00109</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m7">awaymsg</a>[512];
-00110         
-<a name="l00114"></a><a class="code" href="classuserrec.html#m8">00114</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m8">result</a>[256];
-00115         
-<a name="l00116"></a><a class="code" href="classuserrec.html#m9">00116</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m9">carryover</a>[MAXBUF];
+<a name="l00110"></a><a class="code" href="classuserrec.html#m4">00110</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m4">modes</a>[MAXBUF];
+00111         
+<a name="l00112"></a><a class="code" href="classuserrec.html#m5">00112</a>         <a class="code" href="classucrec.html">ucrec</a> <a class="code" href="classuserrec.html#m5">chans</a>[MAXCHANS];
+00113         
+<a name="l00116"></a><a class="code" href="classuserrec.html#m6">00116</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m6">server</a>[256];
 00117         
-<a name="l00118"></a><a class="code" href="classuserrec.html#m10">00118</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classuserrec.html#m10">timeout</a>;
-00119 
-00120         <a class="code" href="classuserrec.html#a0">userrec</a>();
-00121         
-<a name="l00122"></a><a class="code" href="classuserrec.html#a1">00122</a>         <span class="keyword">virtual</span> <a class="code" href="classuserrec.html#a1">~userrec</a>() {  }
-00123         
-00128         <span class="keyword">virtual</span> <span class="keywordtype">char</span>* <a class="code" href="classuserrec.html#a2">GetFullHost</a>();
-00129         
-00135         <span class="keyword">virtual</span> <span class="keywordtype">char</span>* <a class="code" href="classuserrec.html#a3">GetFullRealHost</a>();
-00136         
-00139         <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);
-00140         
-00143         <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);
-00144         
-00149         <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);
-00150         
-00151 };
-00152 
-00153 
-00154 <span class="preprocessor">#endif</span>
-</pre></div><hr><address style="align: right;"><small>Generated on Thu Apr 8 19:12:28 2004 for InspIRCd by
+<a name="l00121"></a><a class="code" href="classuserrec.html#m7">00121</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m7">awaymsg</a>[512];
+00122         
+<a name="l00126"></a><a class="code" href="classuserrec.html#m8">00126</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m8">result</a>[256];
+00127         
+<a name="l00132"></a><a class="code" href="classuserrec.html#m9">00132</a>         <span class="keywordtype">int</span> <a class="code" href="classuserrec.html#m9">flood</a>;
+00133         
+<a name="l00138"></a><a class="code" href="classuserrec.html#m10">00138</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classuserrec.html#m10">timeout</a>;
+00139 
+00140         <a class="code" href="classuserrec.html#a0">userrec</a>();
+00141         
+<a name="l00142"></a><a class="code" href="classuserrec.html#a1">00142</a>         <span class="keyword">virtual</span> <a class="code" href="classuserrec.html#a1">~userrec</a>() {  }
+00143         
+00148         <span class="keyword">virtual</span> <span class="keywordtype">char</span>* <a class="code" href="classuserrec.html#a2">GetFullHost</a>();
+00149         
+00155         <span class="keyword">virtual</span> <span class="keywordtype">char</span>* <a class="code" href="classuserrec.html#a3">GetFullRealHost</a>();
+00156         
+00159         <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);
+00160         
+00163         <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);
+00164         
+00169         <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);
+00170         
+00171 };
+00172 
+00173 
+00174 <span class="preprocessor">#endif</span>
+</pre></div><hr><address style="align: right;"><small>Generated on Sat Apr 17 13:31:38 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>