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, 61 deletions

diff --git a/docs/module-doc/users_8cpp-source.html b/docs/module-doc/users_8cpp-source.html
index a30869ad5..83057ad04 100644
--- a/docs/module-doc/users_8cpp-source.html
+++ b/docs/module-doc/users_8cpp-source.html
@@ -20,7 +20,7 @@
 00012 {
 00013         <span class="comment">// the PROPER way to do it, AVOID bzero at *ALL* costs</span>
 00014         strcpy(nick,<span class="stringliteral">""</span>);
-00015         <a class="code" href="classconnection.html#m3">ip</a> = 0;
+00015         <a class="code" href="classconnection.html#m2">ip</a> = 0;
 00016         <a class="code" href="classuserrec.html#m10">timeout</a> = 0;
 00017         strcpy(ident,<span class="stringliteral">""</span>);
 00018         strcpy(host,<span class="stringliteral">""</span>);
@@ -30,71 +30,76 @@
 00022         strcpy(inbuf,<span class="stringliteral">""</span>);
 00023         strcpy(server,<span class="stringliteral">""</span>);
 00024         strcpy(awaymsg,<span class="stringliteral">""</span>);
-00025         <a class="code" href="classconnection.html#m1">fd</a> = <a class="code" href="classconnection.html#m12">lastping</a> = <a class="code" href="classconnection.html#m13">signon</a> = <a class="code" href="classconnection.html#m14">idle_lastmsg</a> = <a class="code" href="classconnection.html#m15">nping</a> = <a class="code" href="classconnection.html#m11">registered</a> = 0;
-00026         <a class="code" href="classconnection.html#m10">port</a> = <a class="code" href="classconnection.html#m5">bytes_in</a> = <a class="code" href="classconnection.html#m6">bytes_out</a> = <a class="code" href="classconnection.html#m7">cmds_in</a> = <a class="code" href="classconnection.html#m8">cmds_out</a> = 0;
-00027         <a class="code" href="classconnection.html#m9">haspassed</a> = <span class="keyword">false</span>;
+00025         <a class="code" href="classconnection.html#m0">fd</a> = <a class="code" href="classconnection.html#m12">lastping</a> = <a class="code" href="classconnection.html#m13">signon</a> = <a class="code" href="classconnection.html#m14">idle_lastmsg</a> = <a class="code" href="classconnection.html#m15">nping</a> = <a class="code" href="classconnection.html#m10">registered</a> = 0;
+00026         <a class="code" href="classuserrec.html#m9">flood</a> = <a class="code" href="classconnection.html#m9">port</a> = <a class="code" href="classconnection.html#m4">bytes_in</a> = <a class="code" href="classconnection.html#m5">bytes_out</a> = <a class="code" href="classconnection.html#m6">cmds_in</a> = <a class="code" href="classconnection.html#m7">cmds_out</a> = 0;
+00027         <a class="code" href="classconnection.html#m8">haspassed</a> = <span class="keyword">false</span>;
 00028         strcpy(result,<span class="stringliteral">""</span>);
 00029         <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; MAXCHANS; i++)
 00030         {
-00031                 <a class="code" href="classuserrec.html#m5">chans</a>[i].<a class="code" href="classucrec.html#m1">channel</a> = NULL;
-00032         }
-00033         <a class="code" href="classuserrec.html#o0">invites</a>.clear();
-00034 }
-00035 
+00031                 this-&gt;<a class="code" href="classuserrec.html#m5">chans</a>[i].<a class="code" href="classucrec.html#m1">channel</a> = NULL;
+00032                 this-&gt;<a class="code" href="classuserrec.html#m5">chans</a>[i].<a class="code" href="classucrec.html#m0">uc_modes</a> = 0;
+00033         }
+00034         <a class="code" href="classuserrec.html#o0">invites</a>.clear();
+00035 }
 00036 
-00037  
-<a name="l00038"></a><a class="code" href="classuserrec.html#a2">00038</a> <span class="keywordtype">char</span>* <a class="code" href="classuserrec.html#a2">userrec::GetFullHost</a>()
-00039 {
-00040         sprintf(result,<span class="stringliteral">"%s!%s@%s"</span>,nick,ident,dhost);
-00041         <span class="keywordflow">return</span> <a class="code" href="classuserrec.html#m8">result</a>;
-00042 }
-00043 
+00037 
+00038  
+<a name="l00039"></a><a class="code" href="classuserrec.html#a2">00039</a> <span class="keywordtype">char</span>* <a class="code" href="classuserrec.html#a2">userrec::GetFullHost</a>()
+00040 {
+00041         sprintf(result,<span class="stringliteral">"%s!%s@%s"</span>,nick,ident,dhost);
+00042         <span class="keywordflow">return</span> <a class="code" href="classuserrec.html#m8">result</a>;
+00043 }
 00044 
-<a name="l00045"></a><a class="code" href="classuserrec.html#a3">00045</a> <span class="keywordtype">char</span>* <a class="code" href="classuserrec.html#a3">userrec::GetFullRealHost</a>()
-00046 {
-00047         sprintf(result,<span class="stringliteral">"%s!%s@%s"</span>,nick,ident,host);
-00048         <span class="keywordflow">return</span> <a class="code" href="classuserrec.html#m8">result</a>;
-00049 }
-00050 
-<a name="l00051"></a><a class="code" href="classuserrec.html#a4">00051</a> <span class="keywordtype">bool</span> <a class="code" href="classuserrec.html#a4">userrec::IsInvited</a>(<span class="keywordtype">char</span>* channel)
-00052 {
-00053         <span class="keywordflow">for</span> (InvitedList::iterator i = <a class="code" href="classuserrec.html#o0">invites</a>.begin(); i != <a class="code" href="classuserrec.html#o0">invites</a>.end(); i++)
-00054         {
-00055                 <span class="keywordflow">if</span> (i-&gt;channel) {
-00056                         <span class="keywordflow">if</span> (!strcasecmp(i-&gt;channel,channel))
-00057                         {
-00058                                 <span class="keywordflow">return</span> <span class="keyword">true</span>;
-00059                         }
-00060                 }
-00061         }
-00062         <span class="keywordflow">return</span> <span class="keyword">false</span>;
-00063 }
-00064 
-<a name="l00065"></a><a class="code" href="classuserrec.html#a5">00065</a> <span class="keywordtype">void</span> <a class="code" href="classuserrec.html#a5">userrec::InviteTo</a>(<span class="keywordtype">char</span>* channel)
-00066 {
-00067         <a class="code" href="classInvited.html">Invited</a> i;
-00068         strcpy(i.<a class="code" href="classInvited.html#m0">channel</a>,channel);
-00069         <a class="code" href="classuserrec.html#o0">invites</a>.push_back(i);
-00070 }
-00071 
-<a name="l00072"></a><a class="code" href="classuserrec.html#a6">00072</a> <span class="keywordtype">void</span> <a class="code" href="classuserrec.html#a6">userrec::RemoveInvite</a>(<span class="keywordtype">char</span>* channel)
-00073 {
-00074         log(DEBUG,<span class="stringliteral">"Removing invites"</span>);
-00075         <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#o0">invites</a>.size())
-00076         {
-00077                 <span class="keywordflow">for</span> (InvitedList::iterator i = <a class="code" href="classuserrec.html#o0">invites</a>.begin(); i != <a class="code" href="classuserrec.html#o0">invites</a>.end(); i++)
-00078                 {
-00079                         <span class="keywordflow">if</span> (i-&gt;channel) {
-00080                                 <span class="keywordflow">if</span> (!strcasecmp(i-&gt;channel,channel))
-00081                                 {
-00082                                         <a class="code" href="classuserrec.html#o0">invites</a>.erase(i);
-00083                                         <span class="keywordflow">return</span>;
-00084                                 }
-00085                         }
-00086                 }
-00087         }
-00088 }
-</pre></div><hr><address style="align: right;"><small>Generated on Thu Apr 8 19:12:28 2004 for InspIRCd by
+00045 
+<a name="l00046"></a><a class="code" href="classuserrec.html#a3">00046</a> <span class="keywordtype">char</span>* <a class="code" href="classuserrec.html#a3">userrec::GetFullRealHost</a>()
+00047 {
+00048         sprintf(result,<span class="stringliteral">"%s!%s@%s"</span>,nick,ident,host);
+00049         <span class="keywordflow">return</span> <a class="code" href="classuserrec.html#m8">result</a>;
+00050 }
+00051 
+<a name="l00052"></a><a class="code" href="classuserrec.html#a4">00052</a> <span class="keywordtype">bool</span> <a class="code" href="classuserrec.html#a4">userrec::IsInvited</a>(<span class="keywordtype">char</span>* channel)
+00053 {
+00054         <span class="keywordflow">for</span> (InvitedList::iterator i = <a class="code" href="classuserrec.html#o0">invites</a>.begin(); i != <a class="code" href="classuserrec.html#o0">invites</a>.end(); i++)
+00055         {
+00056                 <span class="keywordflow">if</span> (i-&gt;channel) {
+00057                         <span class="keywordflow">if</span> (!strcasecmp(i-&gt;channel,channel))
+00058                         {
+00059                                 <span class="keywordflow">return</span> <span class="keyword">true</span>;
+00060                         }
+00061                 }
+00062         }
+00063         <span class="keywordflow">return</span> <span class="keyword">false</span>;
+00064 }
+00065 
+<a name="l00066"></a><a class="code" href="classuserrec.html#a5">00066</a> <span class="keywordtype">void</span> <a class="code" href="classuserrec.html#a5">userrec::InviteTo</a>(<span class="keywordtype">char</span>* channel)
+00067 {
+00068         <a class="code" href="classInvited.html">Invited</a> i;
+00069         strcpy(i.<a class="code" href="classInvited.html#m0">channel</a>,channel);
+00070         <a class="code" href="classuserrec.html#o0">invites</a>.push_back(i);
+00071 }
+00072 
+<a name="l00073"></a><a class="code" href="classuserrec.html#a6">00073</a> <span class="keywordtype">void</span> <a class="code" href="classuserrec.html#a6">userrec::RemoveInvite</a>(<span class="keywordtype">char</span>* channel)
+00074 {
+00075         log(DEBUG,<span class="stringliteral">"Removing invites"</span>);
+00076         <span class="keywordflow">if</span> (channel)
+00077         {
+00078                 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#o0">invites</a>.size())
+00079                 {
+00080                         <span class="keywordflow">for</span> (InvitedList::iterator i = <a class="code" href="classuserrec.html#o0">invites</a>.begin(); i != <a class="code" href="classuserrec.html#o0">invites</a>.end(); i++)
+00081                         {
+00082                                 <span class="keywordflow">if</span> (i-&gt;channel)
+00083                                 {
+00084                                         <span class="keywordflow">if</span> (!strcasecmp(i-&gt;channel,channel))
+00085                                         {
+00086                                                 <a class="code" href="classuserrec.html#o0">invites</a>.erase(i);
+00087                                                 <span class="keywordflow">return</span>;
+00088                                         }
+00089                                 }
+00090                         }
+00091                 }
+00092         }
+00093 }
+</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>