]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/module-doc/classclassbase.html
Added final documentation for inspircd Beta 4
[user/henk/code/inspircd.git] / docs / module-doc / classclassbase.html
index 8033932289a9d1f31819baf8691d477cf34ff756..89c86c19b8963148606e0368a7cbb20b6d19674c 100644 (file)
@@ -1,50 +1,46 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
-<title>classbase class Reference</title>
-<link href="doxygen.css" rel="stylesheet" type="text/css">
+<title>InspIRCd: classbase class Reference</title>
+<link href="inspircd.css" rel="stylesheet" type="text/css">
 </head><body>
-<!-- Generated by Doxygen 1.3-rc2 -->
-<center>
-<a class="qindex" href="main.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
-<hr><h1>classbase Class Reference</h1><code>#include &lt;<a class="el" href="base_8h-source.html">base.h</a>&gt;</code>
-<p>
-<p>Inheritance diagram for classbase:
-<p><center><img src="classclassbase.png" usemap="#classbase_map" border="0" alt=""></center>
-<map name="classbase_map">
-<area href="classAdmin.html" alt="Admin" shape="rect" coords="108,56,206,80">
-<area href="classchanrec.html" alt="chanrec" shape="rect" coords="108,112,206,136">
-<area href="classcommand__t.html" alt="command_t" shape="rect" coords="108,168,206,192">
-<area href="classConfigReader.html" alt="ConfigReader" shape="rect" coords="108,224,206,248">
-<area href="classConnectClass.html" alt="ConnectClass" shape="rect" coords="108,280,206,304">
-<area href="classconnection.html" alt="connection" shape="rect" coords="108,336,206,360">
-<area href="classFileReader.html" alt="FileReader" shape="rect" coords="108,392,206,416">
-<area href="classHostItem.html" alt="HostItem" shape="rect" coords="108,448,206,472">
-<area href="classInvited.html" alt="Invited" shape="rect" coords="108,504,206,528">
-<area href="classModule.html" alt="Module" shape="rect" coords="108,560,206,584">
-<area href="classModuleFactory.html" alt="ModuleFactory" shape="rect" coords="108,616,206,640">
-<area href="classServer.html" alt="Server" shape="rect" coords="108,672,206,696">
-<area href="classucrec.html" alt="ucrec" shape="rect" coords="108,728,206,752">
-<area href="classVersion.html" alt="Version" shape="rect" coords="108,784,206,808">
-</map>
+<!-- Generated by Doxygen 1.3.3 -->
+<div class="qindex"><a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Compound&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Compound&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
+<h1>classbase Class Reference</h1>The base class for all inspircd classes.  
+<a href="#_details">More...</a>
+<p>
+<code>#include &lt;<a class="el" href="base_8h-source.html">base.h</a>&gt;</code>
+<p>
+Inherited by <a class="el" href="classAdmin.html">Admin</a>, <a class="el" href="classConfigReader.html">ConfigReader</a>, <a class="el" href="classConnectClass.html">ConnectClass</a>, <a class="el" href="classExtensible.html">Extensible</a>, <a class="el" href="classExtMode.html">ExtMode</a>, <a class="el" href="classFileReader.html">FileReader</a>, <a class="el" href="classHostItem.html">HostItem</a>, <a class="el" href="classInvited.html">Invited</a>, <a class="el" href="classModeParameter.html">ModeParameter</a>, <a class="el" href="classModule.html">Module</a>, <a class="el" href="classModuleFactory.html">ModuleFactory</a>, <a class="el" href="classModuleMessage.html">ModuleMessage</a>, <a class="el" href="classServer.html">Server</a>, <a class="el" href="classucrec.html">ucrec</a>, <a class="el" href="classVersion.html">Version</a>, and <a class="el" href="classXLine.html">XLine</a>.
+<p>
 <a href="classclassbase-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>
-<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classclassbase.html#a0">classbase</a> ()</td></tr>
-<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classclassbase.html#a1">~classbase</a> ()</td></tr>
+<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classclassbase.html#a0">classbase</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor, Sets the object's time. </em> <a href="#a0"></a><em><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classclassbase.html#a1">~classbase</a> ()</td></tr>
+
 <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
-<tr><td nowrap align=right valign=top>time_t&nbsp;</td><td valign=bottom><a class="el" href="classclassbase.html#m0">age</a></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>time_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classclassbase.html#o0">age</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Time that the object was instantiated (used for TS calculation etc). </em> <a href="#o0"></a><em><br><br></td></tr>
 </table>
-<hr><h2>Constructor &amp; Destructor Documentation</h2>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+The base class for all inspircd classes. 
+<p>
+
+<p>
+Definition at line <a class="el" href="base_8h-source.html#l00029">29</a> of file <a class="el" href="base_8h-source.html">base.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
 <a name="a0" doxytag="classbase::classbase"></a><p>
-<table width="100%" cellpadding="2" cellspacing="0" border="0">
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
   <tr>
-    <td class="md">
+    <td class="mdRow">
       <table cellpadding="0" cellspacing="0" border="0">
         <tr>
           <td class="md" nowrap valign="top"> classbase::classbase </td>
           <td class="md" valign="top">(&nbsp;</td>
-          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
-          <td class="md" valign="top">)&nbsp;</td>
+          <td class="mdname1" valign="top" nowrap>          </td>
+          <td class="md" valign="top">&nbsp;)&nbsp;</td>
           <td class="md" nowrap><code> [inline]</code></td>
         </tr>
 
     <td>
 
 <p>
+Constructor, Sets the object's time. 
+<p>
 
 <p>
-Definition at line <a class="el" href="base_8h-source.html#l00022">22</a> of file <a class="el" href="base_8h-source.html">base.h</a>.
+Definition at line <a class="el" href="base_8h-source.html#l00039">39</a> of file <a class="el" href="base_8h-source.html">base.h</a>.
 <p>
-<div class="fragment"><pre>00022 { <a class="code" href="classclassbase.html#m0">age</a> = time(NULL); }
+References <a class="el" href="base_8h-source.html#l00034">age</a>.
+<p>
+<div class="fragment"><pre>00039 { <a class="code" href="classclassbase.html#o0">age</a> = time(NULL); }
 </pre></div>    </td>
   </tr>
 </table>
 <a name="a1" doxytag="classbase::~classbase"></a><p>
-<table width="100%" cellpadding="2" cellspacing="0" border="0">
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
   <tr>
-    <td class="md">
+    <td class="mdRow">
       <table cellpadding="0" cellspacing="0" border="0">
         <tr>
-          <td class="md" nowrap valign="top"> classbase::~classbase </td>
+          <td class="md" nowrap valign="top"> classbase::~<a class="el" href="classclassbase.html">classbase</a> </td>
           <td class="md" valign="top">(&nbsp;</td>
-          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
-          <td class="md" valign="top">)&nbsp;</td>
+          <td class="mdname1" valign="top" nowrap>          </td>
+          <td class="md" valign="top">&nbsp;)&nbsp;</td>
           <td class="md" nowrap><code> [inline]</code></td>
         </tr>
 
@@ -95,20 +95,20 @@ Definition at line <a class="el" href="base_8h-source.html#l00022">22</a> of fil
 <p>
 
 <p>
-Definition at line <a class="el" href="base_8h-source.html#l00023">23</a> of file <a class="el" href="base_8h-source.html">base.h</a>.
+Definition at line <a class="el" href="base_8h-source.html#l00040">40</a> of file <a class="el" href="base_8h-source.html">base.h</a>.
 <p>
-<div class="fragment"><pre>00023 { }
+<div class="fragment"><pre>00040 { }
 </pre></div>    </td>
   </tr>
 </table>
 <hr><h2>Member Data Documentation</h2>
-<a name="m0" doxytag="classbase::age"></a><p>
-<table width="100%" cellpadding="2" cellspacing="0" border="0">
+<a name="o0" doxytag="classbase::age"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
   <tr>
-    <td class="md">
+    <td class="mdRow">
       <table cellpadding="0" cellspacing="0" border="0">
         <tr>
-          <td class="md" nowrap valign="top"> time_t classbase::age
+          <td class="md" nowrap valign="top"> time_t <a class="el" href="classclassbase.html#o0">classbase::age</a>
       </table>
     </td>
   </tr>
@@ -121,16 +121,20 @@ Definition at line <a class="el" href="base_8h-source.html#l00023">23</a> of fil
     <td>
 
 <p>
+Time that the object was instantiated (used for TS calculation etc). 
+<p>
 
 <p>
-Definition at line <a class="el" href="base_8h-source.html#l00020">20</a> of file <a class="el" href="base_8h-source.html">base.h</a>.    </td>
+Definition at line <a class="el" href="base_8h-source.html#l00034">34</a> of file <a class="el" href="base_8h-source.html">base.h</a>.
+<p>
+Referenced by <a class="el" href="base_8h-source.html#l00039">classbase()</a>.    </td>
   </tr>
 </table>
 <hr>The documentation for this class was generated from the following file:<ul>
 <li><a class="el" href="base_8h-source.html">base.h</a></ul>
-<hr><address style="align: right;"><small>Generated on Mon Jan 27 00:16:42 2003 for InspIRCd by
+<hr size="1"><address style="align: right;"><small>Generated on Sat May 7 15:34:23 2005 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>
+<img src="doxygen.png" alt="doxygen" align="middle" border=0 
+</a>1.3.3 </small></address>
 </body>
 </html>