Added manpages, extra docs

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

1 files changed, 65 insertions, 0 deletions

diff --git a/docs/man/Admin.3 b/docs/man/Admin.3
new file mode 100644
index 000000000..67401feae
--- /dev/null
+++ b/docs/man/Admin.3
@@ -0,0 +1,65 @@
+.TH "Admin" 3 "30 Apr 2004" "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 80 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 109 of file modules.cpp.
+.PP
+.nf
+109 : Name(name), Email(email), Nick(nick) { };
+.fi
+.SH "Member Data Documentation"
+.PP 
+.SS "const std::string Admin::Email"
+.PP
+Definition at line 83 of file modules.h.
+.SS "const std::string Admin::Name"
+.PP
+Definition at line 83 of file modules.h.
+.SS "const std::string Admin::Nick"
+.PP
+Definition at line 83 of file modules.h.
+
+.SH "Author"
+.PP 
+Generated automatically by Doxygen for InspIRCd from the source code.