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, 48 insertions, 49 deletions

diff --git a/docs/module-doc/channels_8cpp-source.html b/docs/module-doc/channels_8cpp-source.html
index 6306fdb45..b942e6741 100644
--- a/docs/module-doc/channels_8cpp-source.html
+++ b/docs/module-doc/channels_8cpp-source.html
@@ -177,55 +177,54 @@
 <a name="l00168"></a>00168 
 <a name="l00169"></a><a class="code" href="classchanrec.html#IsCustomModeSet_28char_20mode_29">00169</a> <span class="keywordtype">bool</span> <a class="code" href="classchanrec.html#IsCustomModeSet_28char_20mode_29">chanrec::IsCustomModeSet</a>(<span class="keywordtype">char</span> mode)
 <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 }
-<a name="l00174"></a>00174 
-<a name="l00175"></a><a class="code" href="classchanrec.html#GetModeParameter_28char_20mode_29">00175</a> <a class="code" href="namespaceirc.html#string">std::string</a> <a class="code" href="classchanrec.html#GetModeParameter_28char_20mode_29">chanrec::GetModeParameter</a>(<span class="keywordtype">char</span> mode)
-<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 }
-<a name="l00189"></a>00189 
-<a name="l00190"></a><a class="code" href="classchanrec.html#GetUserCounter_28_29">00190</a> <span class="keywordtype">long</span> <a class="code" href="classchanrec.html#GetUserCounter_28_29">chanrec::GetUserCounter</a>()
-<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 }
-<a name="l00194"></a>00194 
-<a name="l00195"></a><a class="code" href="classchanrec.html#AddUser_28char_20_2Acastuser_29">00195</a> <span class="keywordtype">void</span> <a class="code" href="classchanrec.html#AddUser_28char_20_2Acastuser_29">chanrec::AddUser</a>(<span class="keywordtype">char</span>* castuser)
-<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 }
-<a name="l00200"></a>00200 
-<a name="l00201"></a><a class="code" href="classchanrec.html#DelUser_28char_20_2Acastuser_29">00201</a> <span class="keywordtype">void</span> <a class="code" href="classchanrec.html#DelUser_28char_20_2Acastuser_29">chanrec::DelUser</a>(<span class="keywordtype">char</span>* castuser)
-<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 }
-<a name="l00214"></a>00214 
-<a name="l00215"></a><a class="code" href="classchanrec.html#GetUsers_28_29">00215</a> std::vector&lt;char*&gt; *<a class="code" href="classchanrec.html#GetUsers_28_29">chanrec::GetUsers</a>()
-<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 }
-</pre></div><hr size="1"><address style="align: right;"><small>Generated on Mon Dec 12 13:31:08 2005 for InspIRCd by&nbsp;
+<a name="l00171"></a>00171         <span class="keywordflow">return</span> (strchr(this-&gt;custom_modes,mode));
+<a name="l00172"></a>00172 }
+<a name="l00173"></a>00173 
+<a name="l00174"></a><a class="code" href="classchanrec.html#GetModeParameter_28char_20mode_29">00174</a> <a class="code" href="namespaceirc.html#string">std::string</a> <a class="code" href="classchanrec.html#GetModeParameter_28char_20mode_29">chanrec::GetModeParameter</a>(<span class="keywordtype">char</span> mode)
+<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 }
+<a name="l00188"></a>00188 
+<a name="l00189"></a><a class="code" href="classchanrec.html#GetUserCounter_28_29">00189</a> <span class="keywordtype">long</span> <a class="code" href="classchanrec.html#GetUserCounter_28_29">chanrec::GetUserCounter</a>()
+<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 }
+<a name="l00193"></a>00193 
+<a name="l00194"></a><a class="code" href="classchanrec.html#AddUser_28char_20_2Acastuser_29">00194</a> <span class="keywordtype">void</span> <a class="code" href="classchanrec.html#AddUser_28char_20_2Acastuser_29">chanrec::AddUser</a>(<span class="keywordtype">char</span>* castuser)
+<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 }
+<a name="l00199"></a>00199 
+<a name="l00200"></a><a class="code" href="classchanrec.html#DelUser_28char_20_2Acastuser_29">00200</a> <span class="keywordtype">void</span> <a class="code" href="classchanrec.html#DelUser_28char_20_2Acastuser_29">chanrec::DelUser</a>(<span class="keywordtype">char</span>* castuser)
+<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 }
+<a name="l00213"></a>00213 
+<a name="l00214"></a><a class="code" href="classchanrec.html#GetUsers_28_29">00214</a> std::vector&lt;char*&gt; *<a class="code" href="classchanrec.html#GetUsers_28_29">chanrec::GetUsers</a>()
+<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><hr size="1"><address style="align: right;"><small>Generated on Mon Dec 12 18:30:58 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>