Added manpages, extra docs

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

1 files changed, 98 insertions, 0 deletions

diff --git a/docs/man/users.h.3 b/docs/man/users.h.3
new file mode 100644
index 000000000..cb2b55091
--- /dev/null
+++ b/docs/man/users.h.3
@@ -0,0 +1,98 @@
+.TH "users.h" 3 "30 Apr 2004" "InspIRCd" \" -*- nroff -*-
+.ad l
+.nh
+.SH NAME
+users.h \- 
+.SH SYNOPSIS
+.br
+.PP
+\fC#include 'inspircd_config.h'\fP
+.br
+\fC#include 'channels.h'\fP
+.br
+\fC#include 'connection.h'\fP
+.br
+\fC#include <string>\fP
+.br
+
+.SS "Compounds"
+
+.in +1c
+.ti -1c
+.RI "class \fBConnectClass\fP"
+.br
+.RI "\fIHolds information relevent to <connect allow> and <connect deny> tags in the config file.\fP"
+.ti -1c
+.RI "class \fBInvited\fP"
+.br
+.RI "\fIHolds a channel name to which a user has been invited.\fP"
+.ti -1c
+.RI "class \fBuserrec\fP"
+.br
+.RI "\fIHolds all information about a user This class stores all information about a user connected to the irc server.\fP"
+.in -1c
+.SS "Defines"
+
+.in +1c
+.ti -1c
+.RI "#define \fBSTATUS_OP\fP   4"
+.br
+.ti -1c
+.RI "#define \fBSTATUS_HOP\fP   2"
+.br
+.ti -1c
+.RI "#define \fBSTATUS_VOICE\fP   1"
+.br
+.ti -1c
+.RI "#define \fBSTATUS_NORMAL\fP   0"
+.br
+.ti -1c
+.RI "#define \fBCC_ALLOW\fP   0"
+.br
+.ti -1c
+.RI "#define \fBCC_DENY\fP   1"
+.br
+.in -1c
+.SS "Typedefs"
+
+.in +1c
+.ti -1c
+.RI "typedef std::vector< \fBInvited\fP > \fBInvitedList\fP"
+.br
+.RI "\fIHolds a complete list of all channels to which a user has been invited and has not yet joined.\fP"
+.ti -1c
+.RI "typedef std::vector< \fBConnectClass\fP > \fBClassVector\fP"
+.br
+.RI "\fIHolds a complete list of all allow and deny tags from the configuration file (connection classes).\fP"
+.in -1c
+.SH "Define Documentation"
+.PP 
+.SS "#define CC_ALLOW   0"
+.PP
+Definition at line 20 of file users.h.
+.SS "#define CC_DENY   1"
+.PP
+Definition at line 21 of file users.h.
+.SS "#define STATUS_HOP   2"
+.PP
+Definition at line 16 of file users.h.
+.SS "#define STATUS_NORMAL   0"
+.PP
+Definition at line 18 of file users.h.
+.SS "#define STATUS_OP   4"
+.PP
+Definition at line 15 of file users.h.
+.SS "#define STATUS_VOICE   1"
+.PP
+Definition at line 17 of file users.h.
+.SH "Typedef Documentation"
+.PP 
+.SS "typedef std::vector<\fBConnectClass\fP> ClassVector"
+.PP
+Holds a complete list of all allow and deny tags from the configuration file (connection classes).Definition at line 70 of file users.h.
+.SS "typedef std::vector<\fBInvited\fP> InvitedList"
+.PP
+Holds a complete list of all channels to which a user has been invited and has not yet joined.Definition at line 64 of file users.h.
+.SH "Author"
+.PP 
+Generated automatically by Doxygen for InspIRCd from the source code.