From 52899de0ff2d62ca0542b243c41626010bf62083 Mon Sep 17 00:00:00 2001 From: brain Date: Fri, 25 Mar 2005 03:51:56 +0000 Subject: Documentation update git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@899 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/annotated.html | 75 +++++++++++++++++++++--------------------- 1 file changed, 37 insertions(+), 38 deletions(-) (limited to 'docs/module-doc/annotated.html') diff --git a/docs/module-doc/annotated.html b/docs/module-doc/annotated.html index 150079420..248e8ce91 100644 --- a/docs/module-doc/annotated.html +++ b/docs/module-doc/annotated.html @@ -1,50 +1,49 @@ -Annotated Index +InspIRCd: Annotated Index - - -Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Compound Members File Members -

InspIRCd Compound List

Here are the classes, structs, unions and interfaces with brief descriptions: - - - - - - - - - - + +

InspIRCd Compound List

Here are the classes, structs, unions and interfaces with brief descriptions:

Admin	Holds /ADMIN data This class contains the admin details of the local server
BanItem	A subclass of HostItem designed to hold channel bans (+b)
chanrec	Holds all relevent information for a channel
classbase	The base class for all inspircd classes
command_t	A structure that defines a command
ConfigReader	Allows 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
ConnectClass	Holds information relevent to <connect allow> and <connect deny> tags in the config file
connection	Please note: classes serverrec and userrec both inherit from class connection
ExemptItem	A subclass of HostItem designed to hold channel exempts (+e)
Extensible	Class Extensible is the parent class of many classes such as userrec and chanrec

+ + + + + + + + + + - - + + + + + + + + + + + - - - - - - - - - - - - - + + + + - - - - - + + + + +

Admin	Holds /ADMIN data This class contains the admin details of the local server
BanItem	A subclass of HostItem designed to hold channel bans (+b)
chanrec	Holds all relevent information for a channel
classbase	The base class for all inspircd classes
command_t	A structure that defines a command
ConfigReader	Allows 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
ConnectClass	Holds information relevent to <connect allow> and <connect deny> tags in the config file
connection	Please note: classes serverrec and userrec both inherit from class connection
ExemptItem	A subclass of HostItem designed to hold channel exempts (+e)
Extensible	Class Extensible is the parent class of many classes such as userrec and chanrec
ExtMode
FileReader	Caches a text file into memory and can be used to retrieve lines from it
GLine	GLine class
FileReader	Caches a text file into memory and can be used to retrieve lines from it
GLine	GLine class
HostItem	Holds an entry for a ban list, exemption list, or invite list
InAddr_HashComp
Invited	Holds a channel name to which a user has been invited
InviteItem	A subclass of HostItem designed to hold channel invites (+I)
ircd_connector	Each connection has one or more of these each represents ONE outbound connection to another ircd so each inbound has multiple outbounds
KLine	KLine class
ModeParameter	Holds a custom parameter to a module-defined channel mode e.g
Module	Base class for all InspIRCd modules This class is the base class for InspIRCd modules
ModuleFactory	Instantiates classes inherited from Module This class creates a class inherited from type Module, using new
nspace::hash< in_addr >
nspace::hash< string >
HostItem	Holds an entry for a ban list, exemption list, or invite list
InAddr_HashComp
Invited	Holds a channel name to which a user has been invited
InviteItem	A subclass of HostItem designed to hold channel invites (+I)
ircd_connector	Each connection has one or more of these each represents ONE outbound connection to another ircd so each inbound has multiple outbounds
KLine	KLine class
ModeParameter	Holds a custom parameter to a module-defined channel mode e.g
Module	Base class for all InspIRCd modules This class is the base class for InspIRCd modules
ModuleFactory	Instantiates classes inherited from Module This class creates a class inherited from type Module, using new
packet	Class packet is deprecated
QLine	QLine class
Server	Allows 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
serverrec	A class that defines the local server or a remote server
packet	Class packet is deprecated
QLine	QLine class
Server	Allows 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
serverrec	A class that defines the local server or a remote server
StrHashComp
ucrec	Holds 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
userrec	Holds all information about a user This class stores all information about a user connected to the irc server
Version	Holds a module's Version information The four members (set by the constructor only) indicate details as to the version number of a module
XLine	XLine is the base class for ban lines such as G lines and K lines
ZLine	ZLine class
ucrec	Holds 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
userrec	Holds all information about a user This class stores all information about a user connected to the irc server
Version	Holds a module's Version information The four members (set by the constructor only) indicate details as to the version number of a module
XLine	XLine is the base class for ban lines such as G lines and K lines
ZLine	ZLine class

Generated on Sun May 2 00:09:29 2004 for InspIRCd by +

Generated on Fri Mar 25 03:49:30 2005 for InspIRCd by -

1.3-rc3

+1.3.3

-- cgit v1.2.3