summaryrefslogtreecommitdiff
path: root/docs/man/man3/Admin.3
blob: 55e08841917598e358105492a2d11409a80a6074 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
.TH "Admin" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Admin \- Holds /ADMIN data This class contains the admin details of the local server.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <modules.h>\fP
.PP
Inherits \fBclassbase\fP.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBAdmin\fP (std::string name, std::string email, std::string nick)"
.br
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "const std::string \fBName\fP"
.br
.ti -1c
.RI "const std::string \fBEmail\fP"
.br
.ti -1c
.RI "const std::string \fBNick\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Holds /ADMIN data This class contains the admin details of the local server. 

It is constructed by class \fBServer\fP, and has three read-only values, Name, Email and Nick that contain the specified values for the server where the module is running. 
.PP
Definition at line 123 of file modules.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "Admin::Admin (std::string name, std::string email, std::string nick)"
.PP
Definition at line 304 of file modules.cpp.
.PP
.nf
304 : Name(name), Email(email), Nick(nick) { };
.fi
.SH "Member Data Documentation"
.PP 
.SS "const std::string \fBAdmin::Email\fP"
.PP
Definition at line 126 of file modules.h.
.SS "const std::string \fBAdmin::Name\fP"
.PP
Definition at line 126 of file modules.h.
.SS "const std::string \fBAdmin::Nick\fP"
.PP
Definition at line 126 of file modules.h.

.SH "Author"
.PP 
Generated automatically by Doxygen for InspIRCd from the source code.