Modified documentation

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

1 files changed, 52 insertions, 48 deletions

diff --git a/docs/module-doc/servers_8h-source.html b/docs/module-doc/servers_8h-source.html
index b73e6a898..e1f40b0ef 100644
--- a/docs/module-doc/servers_8h-source.html
+++ b/docs/module-doc/servers_8h-source.html
@@ -9,57 +9,61 @@
 <hr><h1>servers.h</h1><a href="servers_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.1  2003/01/26 23:52:48  brain
-00003 <span class="comment">Modified documentation for base classes
+00003 <span class="comment">Revision 1.2  2003/01/27 00:22:39  brain
+00003 <span class="comment">Modified documentation
 00003 <span class="comment"></span>
-00004 <span class="comment">Revision 1.1  2003/01/26 20:15:00  brain</span>
-00005 <span class="comment">Added server classes for linking</span>
-00006 <span class="comment"></span>
+00004 <span class="comment">Revision 1.2  2003/01/26 23:52:59  brain</span>
+00005 <span class="comment">Modified documentation for base classes</span>
+00006 <span class="comment">Added base classes</span>
 00007 <span class="comment"></span>
-00008 <span class="comment">*/</span>
-00009 
-00010 <span class="preprocessor">#include "inspircd_config.h"</span> 
-00011 <span class="preprocessor">#include "<a class="code" href="connection_8h.html">connection.h</a>"</span>
-00012 <span class="preprocessor">#include &lt;string&gt;</span>
-00013 <span class="preprocessor">#include &lt;map.h&gt;</span>
-00014  
-00015 <span class="preprocessor">#ifndef __SERVERS_H__ </span>
-00016 <span class="preprocessor"></span><span class="preprocessor">#define __SERVERS_H__ </span>
-00017 <span class="preprocessor"></span> 
-<a name="l00018"></a><a class="code" href="servers_8h.html#a0">00018</a> <span class="preprocessor">#define LINK_ACTIVE     1</span>
-<a name="l00019"></a><a class="code" href="servers_8h.html#a1">00019</a> <span class="preprocessor"></span><span class="preprocessor">#define LINK_INACTIVE   0</span>
-00020 <span class="preprocessor"></span>
-<a name="l00021"></a><a class="code" href="classserverrec.html">00021</a> <span class="keyword">class </span><a class="code" href="classserverrec.html">serverrec</a> : <span class="keyword">public</span> <a class="code" href="classconnection.html">connection</a>
-00022 {
-00023  <span class="keyword">private</span>:
-<a name="l00024"></a><a class="code" href="classserverrec.html#o0">00024</a>         map&lt;string, serverrec*&gt; <a class="code" href="classserverrec.html#o0">leaf</a>; <span class="comment">// list of child servers (leaves)</span>
-00025  <span class="keyword">public</span>:
-<a name="l00026"></a><a class="code" href="classserverrec.html#m0">00026</a>         <span class="keywordtype">char</span> <a class="code" href="classserverrec.html#m0">name</a>[MAXBUF];      <span class="comment">// server name</span>
-<a name="l00027"></a><a class="code" href="classserverrec.html#m1">00027</a>         <span class="keywordtype">int</span> <a class="code" href="classserverrec.html#m1">pingtime</a>;           <span class="comment">// last ping response (ms)</span>
-<a name="l00028"></a><a class="code" href="classserverrec.html#m2">00028</a>         <span class="keywordtype">int</span> <a class="code" href="classserverrec.html#m2">linktype</a>;           <span class="comment">// link type, LINK_ACTIVE or LINK_INACTIVE</span>
-<a name="l00029"></a><a class="code" href="classserverrec.html#m3">00029</a>         time_t <a class="code" href="classserverrec.html#m3">lastping</a>;        <span class="comment">// time the link was last pinged</span>
-<a name="l00030"></a><a class="code" href="classserverrec.html#m4">00030</a>         <span class="keywordtype">long</span> <a class="code" href="classserverrec.html#m4">usercount_i</a>;       <span class="comment">// invisible users on server</span>
-<a name="l00031"></a><a class="code" href="classserverrec.html#m5">00031</a>         <span class="keywordtype">long</span> <a class="code" href="classserverrec.html#m5">usercount</a>;         <span class="comment">// non-invisible users on server</span>
-<a name="l00032"></a><a class="code" href="classserverrec.html#m6">00032</a>         <span class="keywordtype">long</span> <a class="code" href="classserverrec.html#m6">opercount</a>;         <span class="comment">// opers on server</span>
-<a name="l00033"></a><a class="code" href="classserverrec.html#m7">00033</a>         time_t <a class="code" href="classserverrec.html#m7">connected_at</a>;    <span class="comment">// time server was connected into the network</span>
-<a name="l00034"></a><a class="code" href="classserverrec.html#m8">00034</a>         time_t <a class="code" href="classserverrec.html#m8">hops_away</a>;       <span class="comment">// number of hops away (for quick access)</span>
-<a name="l00035"></a><a class="code" href="classserverrec.html#m9">00035</a>         <span class="keywordtype">long</span> <a class="code" href="classserverrec.html#m9">version</a>;           <span class="comment">// ircd version</span>
-<a name="l00036"></a><a class="code" href="classserverrec.html#m10">00036</a>         <span class="keywordtype">bool</span> <a class="code" href="classserverrec.html#m10">jupiter</a>;           <span class="comment">// is a JUPE server (faked to enforce a server ban)</span>
-00037 
-00038         <a class="code" href="classserverrec.html#a0">serverrec</a>();
-00039         <a class="code" href="classserverrec.html#a0">serverrec</a>(<span class="keywordtype">char</span>* n, <span class="keywordtype">int</span> link_t,  <span class="keywordtype">long</span> ver, <span class="keywordtype">bool</span> jupe);
-00040         <a class="code" href="classserverrec.html#a2">~serverrec</a>();
-00041         <span class="keywordtype">void</span> <a class="code" href="classserverrec.html#a3">AddLeaf</a>(<a class="code" href="classserverrec.html">serverrec</a> *child);
-00042         <span class="keywordtype">void</span> <a class="code" href="classserverrec.html#a4">DelLeaf</a>(string n);
-00043 };
-00044 
-00045 
-00046 
-<a name="l00047"></a><a class="code" href="servers_8h.html#a2">00047</a> <span class="keyword">typedef</span> map&lt;string, serverrec*&gt; <a class="code" href="servers_8h.html#a2">server_list</a>;
+00008 <span class="comment">Revision 1.1  2003/01/26 20:15:00  brain</span>
+00009 <span class="comment">Added server classes for linking</span>
+00010 <span class="comment"></span>
+00011 <span class="comment"></span>
+00012 <span class="comment">*/</span>
+00013 
+00014 <span class="preprocessor">#include "inspircd_config.h"</span> 
+00015 <span class="preprocessor">#include "<a class="code" href="connection_8h.html">connection.h</a>"</span>
+00016 <span class="preprocessor">#include &lt;string&gt;</span>
+00017 <span class="preprocessor">#include &lt;map.h&gt;</span>
+00018  
+00019 <span class="preprocessor">#ifndef __SERVERS_H__ </span>
+00020 <span class="preprocessor"></span><span class="preprocessor">#define __SERVERS_H__ </span>
+00021 <span class="preprocessor"></span> 
+<a name="l00022"></a><a class="code" href="servers_8h.html#a0">00022</a> <span class="preprocessor">#define LINK_ACTIVE     1</span>
+<a name="l00023"></a><a class="code" href="servers_8h.html#a1">00023</a> <span class="preprocessor"></span><span class="preprocessor">#define LINK_INACTIVE   0</span>
+00024 <span class="preprocessor"></span>
+<a name="l00025"></a><a class="code" href="classserverrec.html">00025</a> <span class="keyword">class </span><a class="code" href="classserverrec.html">serverrec</a> : <span class="keyword">public</span> <a class="code" href="classconnection.html">connection</a>
+00026 {
+00027  <span class="keyword">private</span>:
+<a name="l00028"></a><a class="code" href="classserverrec.html#o0">00028</a>         map&lt;string, serverrec*&gt; <a class="code" href="classserverrec.html#o0">leaf</a>; <span class="comment">// list of child servers (leaves)</span>
+00029  <span class="keyword">public</span>:
+<a name="l00030"></a><a class="code" href="classserverrec.html#m0">00030</a>         <span class="keywordtype">char</span> <a class="code" href="classserverrec.html#m0">name</a>[MAXBUF];      <span class="comment">// server name</span>
+<a name="l00031"></a><a class="code" href="classserverrec.html#m1">00031</a>         <span class="keywordtype">int</span> <a class="code" href="classserverrec.html#m1">pingtime</a>;           <span class="comment">// last ping response (ms)</span>
+<a name="l00032"></a><a class="code" href="classserverrec.html#m2">00032</a>         <span class="keywordtype">int</span> <a class="code" href="classserverrec.html#m2">linktype</a>;           <span class="comment">// link type, LINK_ACTIVE or LINK_INACTIVE</span>
+<a name="l00033"></a><a class="code" href="classserverrec.html#m3">00033</a>         time_t <a class="code" href="classserverrec.html#m3">lastping</a>;        <span class="comment">// time the link was last pinged</span>
+<a name="l00034"></a><a class="code" href="classserverrec.html#m4">00034</a>         <span class="keywordtype">long</span> <a class="code" href="classserverrec.html#m4">usercount_i</a>;       <span class="comment">// invisible users on server</span>
+<a name="l00035"></a><a class="code" href="classserverrec.html#m5">00035</a>         <span class="keywordtype">long</span> <a class="code" href="classserverrec.html#m5">usercount</a>;         <span class="comment">// non-invisible users on server</span>
+<a name="l00036"></a><a class="code" href="classserverrec.html#m6">00036</a>         <span class="keywordtype">long</span> <a class="code" href="classserverrec.html#m6">opercount</a>;         <span class="comment">// opers on server</span>
+<a name="l00037"></a><a class="code" href="classserverrec.html#m7">00037</a>         time_t <a class="code" href="classserverrec.html#m7">connected_at</a>;    <span class="comment">// time server was connected into the network</span>
+<a name="l00038"></a><a class="code" href="classserverrec.html#m8">00038</a>         time_t <a class="code" href="classserverrec.html#m8">hops_away</a>;       <span class="comment">// number of hops away (for quick access)</span>
+<a name="l00039"></a><a class="code" href="classserverrec.html#m9">00039</a>         <span class="keywordtype">long</span> <a class="code" href="classserverrec.html#m9">version</a>;           <span class="comment">// ircd version</span>
+<a name="l00040"></a><a class="code" href="classserverrec.html#m10">00040</a>         <span class="keywordtype">bool</span> <a class="code" href="classserverrec.html#m10">jupiter</a>;           <span class="comment">// is a JUPE server (faked to enforce a server ban)</span>
+00041 
+00042         <a class="code" href="classserverrec.html#a0">serverrec</a>();
+00043         <a class="code" href="classserverrec.html#a0">serverrec</a>(<span class="keywordtype">char</span>* n, <span class="keywordtype">int</span> link_t,  <span class="keywordtype">long</span> ver, <span class="keywordtype">bool</span> jupe);
+00044         <a class="code" href="classserverrec.html#a2">~serverrec</a>();
+00045         <span class="keywordtype">void</span> <a class="code" href="classserverrec.html#a3">AddLeaf</a>(<a class="code" href="classserverrec.html">serverrec</a> *child);
+00046         <span class="keywordtype">void</span> <a class="code" href="classserverrec.html#a4">DelLeaf</a>(string n);
+00047 };
 00048 
-00049 <span class="preprocessor">#endif</span>
-00050 <span class="preprocessor"></span>
-</pre></div><hr><address style="align: right;"><small>Generated on Sun Jan 26 23:45:47 2003 for InspIRCd by
+00049 
+00050 
+<a name="l00051"></a><a class="code" href="servers_8h.html#a2">00051</a> <span class="keyword">typedef</span> map&lt;string, serverrec*&gt; <a class="code" href="servers_8h.html#a2">server_list</a>;
+00052 
+00053 <span class="preprocessor">#endif</span>
+00054 <span class="preprocessor"></span>
+</pre></div><hr><address style="align: right;"><small>Generated on Mon Jan 27 00:16:41 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>