summaryrefslogtreecommitdiff
path: root/docs/man/man3/channels.h.3
diff options
context:
space:
mode:
authorbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2005-11-27 01:44:46 +0000
committerbrain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>2005-11-27 01:44:46 +0000
commitcd9f9a8add02597a2998ba74b803ed3fbf81314c (patch)
treeb53e3ea035c25a0580e9b31dc31f27ee33c36c96 /docs/man/man3/channels.h.3
parent91755849c3bdf089f4583c119fcbb90ff99bed5b (diff)
Added new documentation
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1966 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/man/man3/channels.h.3')
-rw-r--r--docs/man/man3/channels.h.332
1 files changed, 19 insertions, 13 deletions
diff --git a/docs/man/man3/channels.h.3 b/docs/man/man3/channels.h.3
index 84ded7a0d..e0158a5fa 100644
--- a/docs/man/man3/channels.h.3
+++ b/docs/man/man3/channels.h.3
@@ -1,4 +1,4 @@
-.TH "channels.h" 3 "30 May 2005" "InspIRCd" \" -*- nroff -*-
+.TH "channels.h" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -17,26 +17,22 @@ channels.h \-
\fC#include <string>\fP
.br
-.SS "Compounds"
+.SS "Classes"
.in +1c
.ti -1c
-.RI "class \fBBanItem\fP"
+.RI "class \fBHostItem\fP"
.br
-.RI "\fIA subclass of \fBHostItem\fP designed to hold channel bans (+b). \fP"
+.RI "\fIHolds an entry for a ban list, exemption list, or invite list. \fP"
.ti -1c
-.RI "class \fBchanrec\fP"
+.RI "class \fBBanItem\fP"
.br
-.RI "\fIHolds all relevent information for a channel. \fP"
+.RI "\fIA subclass of \fBHostItem\fP designed to hold channel bans (+b). \fP"
.ti -1c
.RI "class \fBExemptItem\fP"
.br
.RI "\fIA subclass of \fBHostItem\fP designed to hold channel exempts (+e). \fP"
.ti -1c
-.RI "class \fBHostItem\fP"
-.br
-.RI "\fIHolds an entry for a ban list, exemption list, or invite list. \fP"
-.ti -1c
.RI "class \fBInviteItem\fP"
.br
.RI "\fIA subclass of \fBHostItem\fP designed to hold channel invites (+I). \fP"
@@ -45,6 +41,10 @@ channels.h \-
.br
.RI "\fIHolds a custom parameter to a module-defined channel mode e.g. \fP"
.ti -1c
+.RI "class \fBchanrec\fP"
+.br
+.RI "\fIHolds all relevent information for a channel. \fP"
+.ti -1c
.RI "class \fBucrec\fP"
.br
.RI "\fIHolds a user's modes on a channel This class associates a users privilages with a channel by creating a pointer link between a userrec and chanrec class. \fP"
@@ -141,13 +141,19 @@ Definition at line 231 of file channels.h.
.PP
.SS "typedef std::vector<\fBBanItem\fP> \fBBanList\fP"
.PP
-Holds a complete ban list. Definition at line 87 of file channels.h.
+Holds a complete ban list.
+.PP
+Definition at line 87 of file channels.h.
.SS "typedef std::vector<\fBExemptItem\fP> \fBExemptList\fP"
.PP
-Holds a complete exempt list. Definition at line 91 of file channels.h.
+Holds a complete exempt list.
+.PP
+Definition at line 91 of file channels.h.
.SS "typedef std::vector<\fBInviteItem\fP> \fBInviteList\fP"
.PP
-Holds a complete invite list. Definition at line 95 of file channels.h.
+Holds a complete invite list.
+.PP
+Definition at line 95 of file channels.h.
.SH "Author"
.PP
Generated automatically by Doxygen for InspIRCd from the source code.