Added extra documentation for InspSocket (at last)

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

1 files changed, 47 insertions, 50 deletions

diff --git a/docs/module-doc/classchanrec.html b/docs/module-doc/classchanrec.html
index c002e97f0..efda184a8 100644
--- a/docs/module-doc/classchanrec.html
+++ b/docs/module-doc/classchanrec.html
@@ -207,12 +207,12 @@ Add a user pointer to the internal reference list.
 </dl>
 The data inserted into the reference list is a table as it is an arbitary pointer compared to other users by its memory address, as this is a very fast 32 or 64 bit integer comparison.
 <p>
-Definition at line <a class="el" href="channels_8cpp-source.html#l00195">195</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>.
+Definition at line <a class="el" href="channels_8cpp-source.html#l00194">194</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>.
 <p>
-References <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>, and <a class="el" href="channels_8h-source.html#l00115">internal_userlist</a>.<div class="fragment"><pre class="fragment"><a name="l00196"></a>00196 {
-<a name="l00197"></a>00197         <a class="code" href="classchanrec.html#internal_5Fuserlist">internal_userlist</a>.push_back(castuser);
-<a name="l00198"></a>00198         log(<a class="code" href="modules_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"Added casted user to channel's internal list"</span>);
-<a name="l00199"></a>00199 }
+References <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>, and <a class="el" href="channels_8h-source.html#l00115">internal_userlist</a>.<div class="fragment"><pre class="fragment"><a name="l00195"></a>00195 {
+<a name="l00196"></a>00196         <a class="code" href="classchanrec.html#internal_5Fuserlist">internal_userlist</a>.push_back(castuser);
+<a name="l00197"></a>00197         log(<a class="code" href="modules_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"Added casted user to channel's internal list"</span>);
+<a name="l00198"></a>00198 }
 </pre></div>
 <p>
     </td>
@@ -252,20 +252,20 @@ Delete a user pointer to the internal reference list.
 </dl>
 The data removed from the reference list is a table as it is an arbitary pointer compared to other users by its memory address, as this is a very fast 32 or 64 bit integer comparison.
 <p>
-Definition at line <a class="el" href="channels_8cpp-source.html#l00201">201</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>.
-<p>
-References <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>, <a class="el" href="channels_8h-source.html#l00115">internal_userlist</a>, and <a class="el" href="channels_8h-source.html#l00106">name</a>.<div class="fragment"><pre class="fragment"><a name="l00202"></a>00202 {
-<a name="l00203"></a>00203         <span class="keywordflow">for</span> (std::vector&lt;char*&gt;::iterator a = <a class="code" href="classchanrec.html#internal_5Fuserlist">internal_userlist</a>.begin(); a &lt; <a class="code" href="classchanrec.html#internal_5Fuserlist">internal_userlist</a>.end(); a++)
-<a name="l00204"></a>00204         {
-<a name="l00205"></a>00205                 <span class="keywordflow">if</span> (*a == castuser)
-<a name="l00206"></a>00206                 {
-<a name="l00207"></a>00207                         log(<a class="code" href="modules_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"Removed casted user from channel's internal list"</span>);
-<a name="l00208"></a>00208                         <a class="code" href="classchanrec.html#internal_5Fuserlist">internal_userlist</a>.erase(a);
-<a name="l00209"></a>00209                         <span class="keywordflow">return</span>;
-<a name="l00210"></a>00210                 }
-<a name="l00211"></a>00211         }
-<a name="l00212"></a>00212         log(<a class="code" href="modules_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"BUG BUG BUG! Attempt to remove an uncasted user from the internal list of %s!"</span>,<a class="code" href="classchanrec.html#name_5BCHANMAX_5D">name</a>);
-<a name="l00213"></a>00213 }
+Definition at line <a class="el" href="channels_8cpp-source.html#l00200">200</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>.
+<p>
+References <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>, <a class="el" href="channels_8h-source.html#l00115">internal_userlist</a>, and <a class="el" href="channels_8h-source.html#l00106">name</a>.<div class="fragment"><pre class="fragment"><a name="l00201"></a>00201 {
+<a name="l00202"></a>00202         <span class="keywordflow">for</span> (std::vector&lt;char*&gt;::iterator a = <a class="code" href="classchanrec.html#internal_5Fuserlist">internal_userlist</a>.begin(); a &lt; <a class="code" href="classchanrec.html#internal_5Fuserlist">internal_userlist</a>.end(); a++)
+<a name="l00203"></a>00203         {
+<a name="l00204"></a>00204                 <span class="keywordflow">if</span> (*a == castuser)
+<a name="l00205"></a>00205                 {
+<a name="l00206"></a>00206                         log(<a class="code" href="modules_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"Removed casted user from channel's internal list"</span>);
+<a name="l00207"></a>00207                         <a class="code" href="classchanrec.html#internal_5Fuserlist">internal_userlist</a>.erase(a);
+<a name="l00208"></a>00208                         <span class="keywordflow">return</span>;
+<a name="l00209"></a>00209                 }
+<a name="l00210"></a>00210         }
+<a name="l00211"></a>00211         log(<a class="code" href="modules_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"BUG BUG BUG! Attempt to remove an uncasted user from the internal list of %s!"</span>,<a class="code" href="classchanrec.html#name_5BCHANMAX_5D">name</a>);
+<a name="l00212"></a>00212 }
 </pre></div>
 <p>
     </td>
@@ -307,21 +307,21 @@ For example if "+L #foo" is set, and you pass this method 'L', it will return 'f
 <dl compact><dt><b>Returns:</b></dt><dd>The parameter for this mode is returned, or an empty string</dd></dl>
 
 <p>
-Definition at line <a class="el" href="channels_8cpp-source.html#l00175">175</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>.
-<p>
-References <a class="el" href="channels_8cpp-source.html#l00099">custom_mode_params</a>.<div class="fragment"><pre class="fragment"><a name="l00176"></a>00176 {
-<a name="l00177"></a>00177         <span class="keywordflow">if</span> (<a class="code" href="channels_8cpp.html#custom_5Fmode_5Fparams">custom_mode_params</a>.size())
-<a name="l00178"></a>00178         {
-<a name="l00179"></a>00179                 <span class="keywordflow">for</span> (vector&lt;ModeParameter&gt;::iterator i = <a class="code" href="channels_8cpp.html#custom_5Fmode_5Fparams">custom_mode_params</a>.begin(); i &lt; <a class="code" href="channels_8cpp.html#custom_5Fmode_5Fparams">custom_mode_params</a>.end(); i++)
-<a name="l00180"></a>00180                 {
-<a name="l00181"></a>00181                         <span class="keywordflow">if</span> ((i-&gt;mode == mode) &amp;&amp; (!strcasecmp(this-&gt;name,i-&gt;channel)))
-<a name="l00182"></a>00182                         {
-<a name="l00183"></a>00183                                 <span class="keywordflow">return</span> i-&gt;parameter;
-<a name="l00184"></a>00184                         }
-<a name="l00185"></a>00185                 }
-<a name="l00186"></a>00186         }
-<a name="l00187"></a>00187         <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
-<a name="l00188"></a>00188 }
+Definition at line <a class="el" href="channels_8cpp-source.html#l00174">174</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>.
+<p>
+References <a class="el" href="channels_8cpp-source.html#l00099">custom_mode_params</a>.<div class="fragment"><pre class="fragment"><a name="l00175"></a>00175 {
+<a name="l00176"></a>00176         <span class="keywordflow">if</span> (<a class="code" href="channels_8cpp.html#custom_5Fmode_5Fparams">custom_mode_params</a>.size())
+<a name="l00177"></a>00177         {
+<a name="l00178"></a>00178                 <span class="keywordflow">for</span> (vector&lt;ModeParameter&gt;::iterator i = <a class="code" href="channels_8cpp.html#custom_5Fmode_5Fparams">custom_mode_params</a>.begin(); i &lt; <a class="code" href="channels_8cpp.html#custom_5Fmode_5Fparams">custom_mode_params</a>.end(); i++)
+<a name="l00179"></a>00179                 {
+<a name="l00180"></a>00180                         <span class="keywordflow">if</span> ((i-&gt;mode == mode) &amp;&amp; (!strcasecmp(this-&gt;name,i-&gt;channel)))
+<a name="l00181"></a>00181                         {
+<a name="l00182"></a>00182                                 <span class="keywordflow">return</span> i-&gt;parameter;
+<a name="l00183"></a>00183                         }
+<a name="l00184"></a>00184                 }
+<a name="l00185"></a>00185         }
+<a name="l00186"></a>00186         <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
+<a name="l00187"></a>00187 }
 </pre></div>
 <p>
     </td>
@@ -356,9 +356,9 @@ Obtain the channel "user counter" This returns the channel reference counter, wh
 <dl compact><dt><b>Returns:</b></dt><dd>The number of users on this channel</dd></dl>
 
 <p>
-Definition at line <a class="el" href="channels_8cpp-source.html#l00190">190</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00191"></a>00191 {
-<a name="l00192"></a>00192         <span class="keywordflow">return</span> (this-&gt;internal_userlist.size());
-<a name="l00193"></a>00193 }
+Definition at line <a class="el" href="channels_8cpp-source.html#l00189">189</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00190"></a>00190 {
+<a name="l00191"></a>00191         <span class="keywordflow">return</span> (this-&gt;internal_userlist.size());
+<a name="l00192"></a>00192 }
 </pre></div>
 <p>
     </td>
@@ -394,13 +394,13 @@ These are used for rapid comparison to determine channel membership for PRIVMSG,
 <dl compact><dt><b>Returns:</b></dt><dd>This function returns a vector of userrec pointers, each of which has been casted to char* to prevent circular references</dd></dl>
 
 <p>
-Definition at line <a class="el" href="channels_8cpp-source.html#l00215">215</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>.
+Definition at line <a class="el" href="channels_8cpp-source.html#l00214">214</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>.
 <p>
 References <a class="el" href="channels_8h-source.html#l00115">internal_userlist</a>.
 <p>
-Referenced by <a class="el" href="modules_8cpp-source.html#l00445">Server::GetUsers()</a>.<div class="fragment"><pre class="fragment"><a name="l00216"></a>00216 {
-<a name="l00217"></a>00217         <span class="keywordflow">return</span> &amp;<a class="code" href="classchanrec.html#internal_5Fuserlist">internal_userlist</a>;
-<a name="l00218"></a>00218 }
+Referenced by <a class="el" href="modules_8cpp-source.html#l00445">Server::GetUsers()</a>.<div class="fragment"><pre class="fragment"><a name="l00215"></a>00215 {
+<a name="l00216"></a>00216         <span class="keywordflow">return</span> &amp;<a class="code" href="classchanrec.html#internal_5Fuserlist">internal_userlist</a>;
+<a name="l00217"></a>00217 }
 </pre></div>
 <p>
     </td>
@@ -441,12 +441,9 @@ Returns true if a custom mode is set on a channel.
 <dl compact><dt><b>Returns:</b></dt><dd>True if the custom mode is set, false if otherwise</dd></dl>
 
 <p>
-Definition at line <a class="el" href="channels_8cpp-source.html#l00169">169</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>.
-<p>
-References <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>.<div class="fragment"><pre class="fragment"><a name="l00170"></a>00170 {
-<a name="l00171"></a>00171         log(<a class="code" href="modules_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"Checking ISCustomModeSet: %c %s"</span>,mode,this-&gt;custom_modes);
-<a name="l00172"></a>00172         <span class="keywordflow">return</span> (strchr(this-&gt;custom_modes,mode) != 0);
-<a name="l00173"></a>00173 }
+Definition at line <a class="el" href="channels_8cpp-source.html#l00169">169</a> of file <a class="el" href="channels_8cpp-source.html">channels.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00170"></a>00170 {
+<a name="l00171"></a>00171         <span class="keywordflow">return</span> (strchr(this-&gt;custom_modes,mode));
+<a name="l00172"></a>00172 }
 </pre></div>
 <p>
     </td>
@@ -755,7 +752,7 @@ User list (casted to char*'s to stop forward declaration stuff) (chicken and egg
 <p>
 Definition at line <a class="el" href="channels_8h-source.html#l00115">115</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
 <p>
-Referenced by <a class="el" href="channels_8cpp-source.html#l00195">AddUser()</a>, <a class="el" href="channels_8cpp-source.html#l00101">chanrec()</a>, <a class="el" href="channels_8cpp-source.html#l00201">DelUser()</a>, and <a class="el" href="channels_8cpp-source.html#l00215">GetUsers()</a>.    </td>
+Referenced by <a class="el" href="channels_8cpp-source.html#l00194">AddUser()</a>, <a class="el" href="channels_8cpp-source.html#l00101">chanrec()</a>, <a class="el" href="channels_8cpp-source.html#l00200">DelUser()</a>, and <a class="el" href="channels_8cpp-source.html#l00214">GetUsers()</a>.    </td>
   </tr>
 </table>
 <a class="anchor" name="key_5B_33_32_5D"></a><!-- doxytag: member="chanrec::key" ref="key_5B_33_32_5D" args="[32]" --><p>
@@ -842,7 +839,7 @@ The channels name.
 <p>
 Definition at line <a class="el" href="channels_8h-source.html#l00106">106</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
 <p>
-Referenced by <a class="el" href="channels_8cpp-source.html#l00101">chanrec()</a>, <a class="el" href="channels_8cpp-source.html#l00201">DelUser()</a>, and <a class="el" href="modules_8cpp-source.html#l00681">Server::PseudoToUser()</a>.    </td>
+Referenced by <a class="el" href="channels_8cpp-source.html#l00101">chanrec()</a>, <a class="el" href="channels_8cpp-source.html#l00200">DelUser()</a>, and <a class="el" href="modules_8cpp-source.html#l00681">Server::PseudoToUser()</a>.    </td>
   </tr>
 </table>
 <a class="anchor" name="setby_5BNICKMAX_5D"></a><!-- doxytag: member="chanrec::setby" ref="setby_5BNICKMAX_5D" args="[NICKMAX]" --><p>
@@ -934,7 +931,7 @@ Referenced by <a class="el" href="channels_8cpp-source.html#l00101">chanrec()</a
 </table>
 <hr>The documentation for this class was generated from the following files:<ul>
 <li><a class="el" href="channels_8h-source.html">channels.h</a><li><a class="el" href="channels_8cpp-source.html">channels.cpp</a></ul>
-<hr size="1"><address style="align: right;"><small>Generated on Mon Dec 12 13:31:11 2005 for InspIRCd by&nbsp;
+<hr size="1"><address style="align: right;"><small>Generated on Mon Dec 12 18:31:01 2005 for InspIRCd by&nbsp;
 <a href="http://www.doxygen.org/index.html">
 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
 </body>