Documentation update

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

1 files changed, 47 insertions, 45 deletions

diff --git a/docs/man/man3/modules.h.3 b/docs/man/man3/modules.h.3
index f98d6b440..591d46a91 100644
--- a/docs/man/man3/modules.h.3
+++ b/docs/man/man3/modules.h.3
@@ -1,4 +1,4 @@
-.TH "modules.h" 3 "2 May 2004" "InspIRCd" \" -*- nroff -*-
+.TH "modules.h" 3 "25 Mar 2005" "InspIRCd" \" -*- nroff -*-
 .ad l
 .nh
 .SH NAME
@@ -25,31 +25,31 @@ modules.h \-
 .ti -1c
 .RI "class \fBAdmin\fP"
 .br
-.RI "\fIHolds /ADMIN data This class contains the admin details of the local server.\fP"
+.RI "\fIHolds /ADMIN data This class contains the admin details of the local server. \fP"
 .ti -1c
 .RI "class \fBConfigReader\fP"
 .br
-.RI "\fIAllows reading of values from configuration files This class allows a module to read from either the main configuration file (inspircd.conf) or from a module-specified configuration file.\fP"
+.RI "\fIAllows reading of values from configuration files This class allows a module to read from either the main configuration file (inspircd.conf) or from a module-specified configuration file. \fP"
 .ti -1c
 .RI "class \fBFileReader\fP"
 .br
-.RI "\fICaches a text file into memory and can be used to retrieve lines from it.\fP"
+.RI "\fICaches a text file into memory and can be used to retrieve lines from it. \fP"
 .ti -1c
 .RI "class \fBModule\fP"
 .br
-.RI "\fIBase class for all InspIRCd modules This class is the base class for InspIRCd modules.\fP"
+.RI "\fIBase class for all InspIRCd modules This class is the base class for InspIRCd modules. \fP"
 .ti -1c
 .RI "class \fBModuleFactory\fP"
 .br
-.RI "\fIInstantiates classes inherited from \fBModule\fP This class creates a class inherited from type \fBModule\fP, using new.\fP"
+.RI "\fIInstantiates classes inherited from \fBModule\fP This class creates a class inherited from type \fBModule\fP, using new. \fP"
 .ti -1c
 .RI "class \fBServer\fP"
 .br
-.RI "\fIAllows server output and query functions This class contains methods which allow a module to query the state of the irc server, and produce output to users and other servers.\fP"
+.RI "\fIAllows server output and query functions This class contains methods which allow a module to query the state of the irc server, and produce output to users and other servers. \fP"
 .ti -1c
 .RI "class \fBVersion\fP"
 .br
-.RI "\fIHolds a module's Version information The four members (set by the constructor only) indicate details as to the version number of a module.\fP"
+.RI "\fIHolds a module's Version information The four members (set by the constructor only) indicate details as to the version number of a module. \fP"
 .in -1c
 .SS "Defines"
 
@@ -139,14 +139,14 @@ modules.h \-
 .ti -1c
 .RI "typedef std::deque< std::string > \fBfile_cache\fP"
 .br
-.RI "\fILow level definition of a \fBFileReader\fP classes file cache area.\fP"
+.RI "\fILow level definition of a \fBFileReader\fP classes file cache area. \fP"
 .ti -1c
 .RI "typedef \fBfile_cache\fP \fBstring_list\fP"
 .br
 .ti -1c
 .RI "typedef std::deque< \fBuserrec\fP * > \fBchanuserlist\fP"
 .br
-.RI "\fIHolds a list of users in a channel.\fP"
+.RI "\fIHolds a list of users in a channel. \fP"
 .ti -1c
 .RI "typedef DLLFactory< \fBModuleFactory\fP > \fBircd_module\fP"
 .br
@@ -165,71 +165,73 @@ modules.h \-
 .PP 
 .SS "#define AC_DEHALFOP   6"
 .PP
-Definition at line 37 of file modules.h.
+Definition at line 47 of file modules.h.
 .SS "#define AC_DEOP   1"
 .PP
-Definition at line 32 of file modules.h.
+Definition at line 42 of file modules.h.
 .SS "#define AC_DEVOICE   4"
 .PP
-Definition at line 35 of file modules.h.
+Definition at line 45 of file modules.h.
 .SS "#define AC_GENERAL_MODE   8"
 .PP
-Definition at line 39 of file modules.h.
+Definition at line 49 of file modules.h.
 .SS "#define AC_HALFOP   5"
 .PP
-Definition at line 36 of file modules.h.
+Definition at line 46 of file modules.h.
 .SS "#define AC_INVITE   7"
 .PP
-Definition at line 38 of file modules.h.
+Definition at line 48 of file modules.h.
 .SS "#define AC_KICK   0"
 .PP
-Definition at line 31 of file modules.h.
+Definition at line 41 of file modules.h.
 .SS "#define AC_OP   2"
 .PP
-Definition at line 33 of file modules.h.
+Definition at line 43 of file modules.h.
 .SS "#define AC_VOICE   3"
 .PP
-Definition at line 34 of file modules.h.
+Definition at line 44 of file modules.h.
 .SS "#define ACR_ALLOW   2"
 .PP
-Definition at line 29 of file modules.h.
+Definition at line 39 of file modules.h.
 .SS "#define ACR_DEFAULT   0"
 .PP
-Definition at line 27 of file modules.h.
+Definition at line 37 of file modules.h.
 .PP
 Referenced by Module::OnAccessCheck().
 .SS "#define ACR_DENY   1"
 .PP
-Definition at line 28 of file modules.h.
+Definition at line 38 of file modules.h.
 .SS "#define CONF_FILE_NOT_FOUND   0x000200"
 .PP
-Definition at line 610 of file modules.h.
+Definition at line 633 of file modules.h.
 .PP
 Referenced by ConfigReader::ConfigReader().
 .SS "#define CONF_NOT_A_NUMBER   0x000010"
 .PP
-Definition at line 607 of file modules.h.
+Definition at line 630 of file modules.h.
 .PP
 Referenced by ConfigReader::ReadInteger().
 .SS "#define CONF_NOT_UNSIGNED   0x000080"
 .PP
-Definition at line 608 of file modules.h.
+Definition at line 631 of file modules.h.
 .PP
 Referenced by ConfigReader::ReadInteger().
 .SS "#define CONF_VALUE_NOT_FOUND   0x000100"
 .PP
-Definition at line 609 of file modules.h.
+Definition at line 632 of file modules.h.
 .PP
 Referenced by ConfigReader::ReadFlag(), ConfigReader::ReadInteger(), and ConfigReader::ReadValue().
 .SS "#define DEBUG   10"
 .PP
-Definition at line 13 of file modules.h.
+Definition at line 23 of file modules.h.
+.PP
+Referenced by Server::AddExtendedMode(), userrec::HasPermission(), chanrec::IsCustomModeSet(), ModeDefined(), ModeDefinedOper(), ModeIsListMode(), userrec::RemoveInvite(), chanrec::SetCustomMode(), and chanrec::SetCustomModeParam().
 .SS "#define DEFAULT   30"
 .PP
-Definition at line 15 of file modules.h.
+Definition at line 25 of file modules.h.
 .SS "#define FOREACH_MOD   for (int i = 0; i <= \fBMODCOUNT\fP; i++) modules[i]->"
 .PP
-Definition at line 62 of file modules.h.
+Definition at line 72 of file modules.h.
 .SS "#define FOREACH_RESULT(x)"
 .PP
 \fBValue:\fP.nf
@@ -244,49 +246,49 @@ Definition at line 62 of file modules.h.
         }
 .fi
 .PP
-Definition at line 70 of file modules.h.
+Definition at line 80 of file modules.h.
 .SS "#define MT_CHANNEL   1"
 .PP
-Definition at line 21 of file modules.h.
+Definition at line 31 of file modules.h.
 .PP
-Referenced by ModeMakeList().
+Referenced by Server::AddExtendedListMode(), and ModeMakeList().
 .SS "#define MT_CLIENT   2"
 .PP
-Definition at line 22 of file modules.h.
+Definition at line 32 of file modules.h.
 .PP
 Referenced by Server::AddExtendedMode().
 .SS "#define MT_SERVER   3"
 .PP
-Definition at line 23 of file modules.h.
+Definition at line 33 of file modules.h.
 .PP
 Referenced by Server::AddExtendedMode().
 .SS "#define NONE   50"
 .PP
-Definition at line 17 of file modules.h.
+Definition at line 27 of file modules.h.
 .SS "#define SPARSE   40"
 .PP
-Definition at line 16 of file modules.h.
+Definition at line 26 of file modules.h.
 .SS "#define VERBOSE   20"
 .PP
-Definition at line 14 of file modules.h.
+Definition at line 24 of file modules.h.
 .SH "Typedef Documentation"
 .PP 
-.SS "typedef std::deque<\fBuserrec\fP*> chanuserlist"
+.SS "typedef std::deque<\fBuserrec\fP*> \fBchanuserlist\fP"
 .PP
-Holds a list of users in a channel.Definition at line 55 of file modules.h.
+Holds a list of users in a channel. Definition at line 65 of file modules.h.
 .PP
 Referenced by Server::GetUsers().
-.SS "typedef std::deque<std::string> file_cache"
+.SS "typedef std::deque<std::string> \fBfile_cache\fP"
 .PP
-Low level definition of a \fBFileReader\fP classes file cache area.Definition at line 50 of file modules.h.
+Low level definition of a \fBFileReader\fP classes file cache area. Definition at line 60 of file modules.h.
 .PP
 Referenced by FileReader::FileReader(), and FileReader::LoadFile().
-.SS "typedef DLLFactory<\fBModuleFactory\fP> ircd_module"
+.SS "typedef DLLFactory<\fBModuleFactory\fP> \fBircd_module\fP"
 .PP
-Definition at line 767 of file modules.h.
-.SS "typedef \fBfile_cache\fP string_list"
+Definition at line 798 of file modules.h.
+.SS "typedef \fBfile_cache\fP \fBstring_list\fP"
 .PP
-Definition at line 51 of file modules.h.
+Definition at line 61 of file modules.h.
 .PP
 Referenced by Module::OnChannelSync(), and Module::OnUserSync().
 .SH "Function Documentation"