docs/man/man3/Admin.3

   1 .TH "Admin" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 Admin \- Holds /ADMIN data This class contains the admin details of the local server.
   6
   7 .PP
   8 .SH SYNOPSIS
   9 .br
  10 .PP
  11 \fC#include <modules.h>\fP
  12 .PP
  13 Inherits \fBclassbase\fP.
  14 .PP
  15 .SS "Public Member Functions"
  16
  17 .in +1c
  18 .ti -1c
  19 .RI "\fBAdmin\fP (std::string name, std::string email, std::string nick)"
  20 .br
  21 .in -1c
  22 .SS "Public Attributes"
  23
  24 .in +1c
  25 .ti -1c
  26 .RI "const std::string \fBName\fP"
  27 .br
  28 .ti -1c
  29 .RI "const std::string \fBEmail\fP"
  30 .br
  31 .ti -1c
  32 .RI "const std::string \fBNick\fP"
  33 .br
  34 .in -1c
  35 .SH "Detailed Description"
  36 .PP
  37 Holds /ADMIN data This class contains the admin details of the local server.
  38
  39 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.
  40 .PP
  41 Definition at line 114 of file modules.h.
  42 .SH "Constructor & Destructor Documentation"
  43 .PP
  44 .SS "Admin::Admin (std::string name, std::string email, std::string nick)"
  45 .PP
  46 Definition at line 302 of file modules.cpp.
  47 .PP
  48 .nf
  49 302 : Name(name), Email(email), Nick(nick) { };
  50 .fi
  51 .SH "Member Data Documentation"
  52 .PP
  53 .SS "const std::string \fBAdmin::Email\fP"
  54 .PP
  55 Definition at line 117 of file modules.h.
  56 .SS "const std::string \fBAdmin::Name\fP"
  57 .PP
  58 Definition at line 117 of file modules.h.
  59 .SS "const std::string \fBAdmin::Nick\fP"
  60 .PP
  61 Definition at line 117 of file modules.h.
  62
  63 .SH "Author"
  64 .PP
  65 Generated automatically by Doxygen for InspIRCd from the source code.