]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/module-doc/classAdmin.html
Updated documentation scripts
[user/henk/code/inspircd.git] / docs / module-doc / classAdmin.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3 <title>Admin class Reference</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 </head><body>
6 <!-- Generated by Doxygen 1.3-rc2 -->
7 <center>
8 <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>
9 <hr><h1>Admin Class Reference</h1>Holds /ADMIN data This class contains the admin details of the local server. 
10 <a href="#_details">More...</a>
11 <p>
12 <code>#include &lt;<a class="el" href="modules_8h-source.html">modules.h</a>&gt;</code>
13 <p>
14 <a href="classAdmin-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
15 <tr><td></td></tr>
16 <tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
17 <tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classAdmin.html#a0">Admin</a> (string name, string email, string nick)</td></tr>
18 <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
19 <tr><td nowrap align=right valign=top>const string&nbsp;</td><td valign=bottom><a class="el" href="classAdmin.html#m0">Name</a></td></tr>
20 <tr><td nowrap align=right valign=top>const string&nbsp;</td><td valign=bottom><a class="el" href="classAdmin.html#m1">Email</a></td></tr>
21 <tr><td nowrap align=right valign=top>const string&nbsp;</td><td valign=bottom><a class="el" href="classAdmin.html#m2">Nick</a></td></tr>
22 </table>
23 <hr><a name="_details"></a><h2>Detailed Description</h2>
24 Holds /ADMIN data This class contains the admin details of the local server.
25 <p>
26 It is constructed by class <a class="el" href="classServer.html">Server</a>, and has three read-only values, Name, Email and Nick that contain the specified values for the server where the module is running. 
27 <p>
28
29 <p>
30 Definition at line <a class="el" href="modules_8h-source.html#l00073">73</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
31 <a name="a0" doxytag="Admin::Admin"></a><p>
32 <table width="100%" cellpadding="2" cellspacing="0" border="0">
33   <tr>
34     <td class="md">
35       <table cellpadding="0" cellspacing="0" border="0">
36         <tr>
37           <td class="md" nowrap valign="top"> Admin::Admin </td>
38           <td class="md" valign="top">(&nbsp;</td>
39           <td class="md" nowrap valign="top">string&nbsp;</td>
40           <td class="mdname" nowrap>&nbsp; <em>name</em>, </td>
41         </tr>
42         <tr>
43           <td></td>
44           <td></td>
45           <td class="md" nowrap>string&nbsp;</td>
46           <td class="mdname" nowrap>&nbsp; <em>email</em>, </td>
47         </tr>
48         <tr>
49           <td></td>
50           <td></td>
51           <td class="md" nowrap>string&nbsp;</td>
52           <td class="mdname" nowrap>&nbsp; <em>nick</em></td>
53         </tr>
54         <tr>
55           <td></td>
56           <td class="md">)&nbsp;</td>
57           <td class="md" colspan="2"></td>
58         </tr>
59
60       </table>
61     </td>
62   </tr>
63 </table>
64 <table cellspacing=5 cellpadding=0 border=0>
65   <tr>
66     <td>
67       &nbsp;
68     </td>
69     <td>
70
71 <p>
72
73 <p>
74 Definition at line <a class="el" href="modules_8cpp-source.html#l00036">36</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
75 <p>
76 <div class="fragment"><pre>00036 : <a class="code" href="classAdmin.html#m0">Name</a>(name), <a class="code" href="classAdmin.html#m1">Email</a>(email), <a class="code" href="classAdmin.html#m2">Nick</a>(nick) { };
77 </pre></div>    </td>
78   </tr>
79 </table>
80 <hr><h2>Member Data Documentation</h2>
81 <a name="m1" doxytag="Admin::Email"></a><p>
82 <table width="100%" cellpadding="2" cellspacing="0" border="0">
83   <tr>
84     <td class="md">
85       <table cellpadding="0" cellspacing="0" border="0">
86         <tr>
87           <td class="md" nowrap valign="top"> const string Admin::Email
88       </table>
89     </td>
90   </tr>
91 </table>
92 <table cellspacing=5 cellpadding=0 border=0>
93   <tr>
94     <td>
95       &nbsp;
96     </td>
97     <td>
98
99 <p>
100
101 <p>
102 Definition at line <a class="el" href="modules_8h-source.html#l00076">76</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
103   </tr>
104 </table>
105 <a name="m0" doxytag="Admin::Name"></a><p>
106 <table width="100%" cellpadding="2" cellspacing="0" border="0">
107   <tr>
108     <td class="md">
109       <table cellpadding="0" cellspacing="0" border="0">
110         <tr>
111           <td class="md" nowrap valign="top"> const string Admin::Name
112       </table>
113     </td>
114   </tr>
115 </table>
116 <table cellspacing=5 cellpadding=0 border=0>
117   <tr>
118     <td>
119       &nbsp;
120     </td>
121     <td>
122
123 <p>
124
125 <p>
126 Definition at line <a class="el" href="modules_8h-source.html#l00076">76</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
127   </tr>
128 </table>
129 <a name="m2" doxytag="Admin::Nick"></a><p>
130 <table width="100%" cellpadding="2" cellspacing="0" border="0">
131   <tr>
132     <td class="md">
133       <table cellpadding="0" cellspacing="0" border="0">
134         <tr>
135           <td class="md" nowrap valign="top"> const string Admin::Nick
136       </table>
137     </td>
138   </tr>
139 </table>
140 <table cellspacing=5 cellpadding=0 border=0>
141   <tr>
142     <td>
143       &nbsp;
144     </td>
145     <td>
146
147 <p>
148
149 <p>
150 Definition at line <a class="el" href="modules_8h-source.html#l00076">76</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
151   </tr>
152 </table>
153 <hr>The documentation for this class was generated from the following files:<ul>
154 <li><a class="el" href="modules_8h-source.html">modules.h</a><li><a class="el" href="modules_8cpp-source.html">modules.cpp</a></ul>
155 <hr><address style="align: right;"><small>Generated on Thu Jan 23 20:28:58 2003 for InspIRCd by
156 <a href="http://www.doxygen.org/index.html">
157 <img src="doxygen.png" alt="doxygen" align="middle" border=0 
158 width=110 height=53></a>1.3-rc2 </small></address>
159 </body>
160 </html>