Modified documentation for base classes

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

1 files changed, 35 insertions, 30 deletions

diff --git a/docs/module-doc/classchanrec.html b/docs/module-doc/classchanrec.html
index 2c9e2efcb..0fe1d45bc 100644
--- a/docs/module-doc/classchanrec.html
+++ b/docs/module-doc/classchanrec.html
@@ -11,6 +11,11 @@
 <p>
 <code>#include &lt;<a class="el" href="channels_8h-source.html">channels.h</a>&gt;</code>
 <p>
+<p>Inheritance diagram for chanrec:
+<p><center><img src="classchanrec.png" usemap="#chanrec_map" border="0" alt=""></center>
+<map name="chanrec_map">
+<area href="classclassbase.html" alt="classbase" shape="rect" coords="0,0,68,24">
+</map>
 <a href="classchanrec-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
 <tr><td></td></tr>
 <tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
@@ -56,7 +61,7 @@ This class represents a channel, and contains its name, modes, time created, top
 <p>
 
 <p>
-Definition at line <a class="el" href="channels_8h-source.html#l00085">85</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
+Definition at line <a class="el" href="channels_8h-source.html#l00086">86</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
 <a name="a0" doxytag="chanrec::chanrec"></a><p>
 <table width="100%" cellpadding="2" cellspacing="0" border="0">
   <tr>
@@ -86,17 +91,17 @@ Creates a channel record and initialises it with default values.
 <p>
 
 <p>
-Definition at line <a class="el" href="channels_8h-source.html#l00153">153</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
-<p>
-<div class="fragment"><pre>00154         {
-00155                 strcpy(name,<span class="stringliteral">""</span>);
-00156                 strcpy(custom_modes,<span class="stringliteral">""</span>);
-00157                 strcpy(topic,<span class="stringliteral">""</span>);
-00158                 strcpy(setby,<span class="stringliteral">""</span>);
-00159                 strcpy(key,<span class="stringliteral">""</span>);
-00160                 <a class="code" href="classchanrec.html#m3">created</a> = <a class="code" href="classchanrec.html#m4">topicset</a> = <a class="code" href="classchanrec.html#m6">limit</a> = 0;
-00161                 <a class="code" href="classchanrec.html#m8">topiclock</a> = <a class="code" href="classchanrec.html#m9">noexternal</a> = <a class="code" href="classchanrec.html#m10">inviteonly</a> = <a class="code" href="classchanrec.html#m11">moderated</a> = <a class="code" href="classchanrec.html#m12">secret</a> = <a class="code" href="classchanrec.html#m13">c_private</a> = <span class="keyword">false</span>;
-00162         }
+Definition at line <a class="el" href="channels_8h-source.html#l00154">154</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
+<p>
+<div class="fragment"><pre>00155         {
+00156                 strcpy(name,<span class="stringliteral">""</span>);
+00157                 strcpy(custom_modes,<span class="stringliteral">""</span>);
+00158                 strcpy(topic,<span class="stringliteral">""</span>);
+00159                 strcpy(setby,<span class="stringliteral">""</span>);
+00160                 strcpy(key,<span class="stringliteral">""</span>);
+00161                 <a class="code" href="classchanrec.html#m3">created</a> = <a class="code" href="classchanrec.html#m4">topicset</a> = <a class="code" href="classchanrec.html#m6">limit</a> = 0;
+00162                 <a class="code" href="classchanrec.html#m8">topiclock</a> = <a class="code" href="classchanrec.html#m9">noexternal</a> = <a class="code" href="classchanrec.html#m10">inviteonly</a> = <a class="code" href="classchanrec.html#m11">moderated</a> = <a class="code" href="classchanrec.html#m12">secret</a> = <a class="code" href="classchanrec.html#m13">c_private</a> = <span class="keyword">false</span>;
+00163         }
 </pre></div>    </td>
   </tr>
 </table>
@@ -127,9 +132,9 @@ Definition at line <a class="el" href="channels_8h-source.html#l00153">153</a> o
 <p>
 
 <p>
-Definition at line <a class="el" href="channels_8h-source.html#l00164">164</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
+Definition at line <a class="el" href="channels_8h-source.html#l00165">165</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.
 <p>
-<div class="fragment"><pre>00164 { <span class="comment">/* stub */</span> }
+<div class="fragment"><pre>00165 { <span class="comment">/* stub */</span> }
 </pre></div>    </td>
   </tr>
 </table>
@@ -157,7 +162,7 @@ The list of all bans set on the channel.
 <p>
 
 <p>
-Definition at line <a class="el" href="channels_8h-source.html#l00149">149</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
+Definition at line <a class="el" href="channels_8h-source.html#l00150">150</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
   </tr>
 </table>
 <a name="m13" doxytag="chanrec::c_private"></a><p>
@@ -183,7 +188,7 @@ Nonzero if the mode +p is set.
 <p>
 This value cannot be set at the same time as <a class="el" href="classchanrec.html#m12">chanrec::secret</a>
 <p>
-Definition at line <a class="el" href="channels_8h-source.html#l00145">145</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
+Definition at line <a class="el" href="channels_8h-source.html#l00146">146</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
   </tr>
 </table>
 <a name="m3" doxytag="chanrec::created"></a><p>
@@ -209,7 +214,7 @@ Creation time.
 <p>
 
 <p>
-Definition at line <a class="el" href="channels_8h-source.html#l00101">101</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
+Definition at line <a class="el" href="channels_8h-source.html#l00102">102</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
   </tr>
 </table>
 <a name="m1" doxytag="chanrec::custom_modes"></a><p>
@@ -235,7 +240,7 @@ Custom modes for the channel.
 <p>
 Plugins may use this field in any way they see fit.
 <p>
-Definition at line <a class="el" href="channels_8h-source.html#l00094">94</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
+Definition at line <a class="el" href="channels_8h-source.html#l00095">95</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
   </tr>
 </table>
 <a name="m10" doxytag="chanrec::inviteonly"></a><p>
@@ -261,7 +266,7 @@ Nonzero if the mode +i is set.
 <p>
 
 <p>
-Definition at line <a class="el" href="channels_8h-source.html#l00131">131</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
+Definition at line <a class="el" href="channels_8h-source.html#l00132">132</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
   </tr>
 </table>
 <a name="m7" doxytag="chanrec::key"></a><p>
@@ -287,7 +292,7 @@ Contains the channel key.
 <p>
 If this value is an empty string, there is no channel key in place.
 <p>
-Definition at line <a class="el" href="channels_8h-source.html#l00119">119</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
+Definition at line <a class="el" href="channels_8h-source.html#l00120">120</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
   </tr>
 </table>
 <a name="m6" doxytag="chanrec::limit"></a><p>
@@ -313,7 +318,7 @@ Contains the channel user limit.
 <p>
 If this value is zero, there is no limit in place.
 <p>
-Definition at line <a class="el" href="channels_8h-source.html#l00114">114</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
+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>.    </td>
   </tr>
 </table>
 <a name="m11" doxytag="chanrec::moderated"></a><p>
@@ -339,7 +344,7 @@ Nonzero if the mode +m is set.
 <p>
 
 <p>
-Definition at line <a class="el" href="channels_8h-source.html#l00135">135</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
+Definition at line <a class="el" href="channels_8h-source.html#l00136">136</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
   </tr>
 </table>
 <a name="m0" doxytag="chanrec::name"></a><p>
@@ -365,7 +370,7 @@ The channels name.
 <p>
 
 <p>
-Definition at line <a class="el" href="channels_8h-source.html#l00090">90</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
+Definition at line <a class="el" href="channels_8h-source.html#l00091">91</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
   </tr>
 </table>
 <a name="m9" doxytag="chanrec::noexternal"></a><p>
@@ -391,7 +396,7 @@ Nonzero if the mode +n is set.
 <p>
 
 <p>
-Definition at line <a class="el" href="channels_8h-source.html#l00127">127</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
+Definition at line <a class="el" href="channels_8h-source.html#l00128">128</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
   </tr>
 </table>
 <a name="m12" doxytag="chanrec::secret"></a><p>
@@ -417,7 +422,7 @@ Nonzero if the mode +s is set.
 <p>
 This value cannot be set at the same time as <a class="el" href="classchanrec.html#m13">chanrec::c_private</a>
 <p>
-Definition at line <a class="el" href="channels_8h-source.html#l00140">140</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
+Definition at line <a class="el" href="channels_8h-source.html#l00141">141</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
   </tr>
 </table>
 <a name="m5" doxytag="chanrec::setby"></a><p>
@@ -443,7 +448,7 @@ The last user to set the topic.
 <p>
 If this member is an empty string, no topic was ever set.
 <p>
-Definition at line <a class="el" href="channels_8h-source.html#l00109">109</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
+Definition at line <a class="el" href="channels_8h-source.html#l00110">110</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
   </tr>
 </table>
 <a name="m2" doxytag="chanrec::topic"></a><p>
@@ -469,7 +474,7 @@ Channel topic.
 <p>
 If this is an empty string, no channel topic is set.
 <p>
-Definition at line <a class="el" href="channels_8h-source.html#l00098">98</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
+Definition at line <a class="el" href="channels_8h-source.html#l00099">99</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
   </tr>
 </table>
 <a name="m8" doxytag="chanrec::topiclock"></a><p>
@@ -495,7 +500,7 @@ Nonzero if the mode +t is set.
 <p>
 
 <p>
-Definition at line <a class="el" href="channels_8h-source.html#l00123">123</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
+Definition at line <a class="el" href="channels_8h-source.html#l00124">124</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
   </tr>
 </table>
 <a name="m4" doxytag="chanrec::topicset"></a><p>
@@ -521,12 +526,12 @@ Time topic was set.
 <p>
 If no topic was ever set, this will be equal to <a class="el" href="classchanrec.html#m3">chanrec::created</a>
 <p>
-Definition at line <a class="el" href="channels_8h-source.html#l00105">105</a> of file <a class="el" href="channels_8h-source.html">channels.h</a>.    </td>
+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>.    </td>
   </tr>
 </table>
 <hr>The documentation for this class was generated from the following file:<ul>
 <li><a class="el" href="channels_8h-source.html">channels.h</a></ul>
-<hr><address style="align: right;"><small>Generated on Thu Jan 23 20:28:58 2003 for InspIRCd by
+<hr><address style="align: right;"><small>Generated on Sun Jan 26 23:45:48 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>