From 755d67224f033aaa9b4ef3d2dd00f46bb8c19dc2 Mon Sep 17 00:00:00 2001 From: brain Date: Thu, 7 Apr 2005 20:15:05 +0000 Subject: New docs to match extra module Version class stuff, etc git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1008 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/modules_8h.html | 224 ++++++++++++++++++++++++++++++---------- 1 file changed, 168 insertions(+), 56 deletions(-) (limited to 'docs/module-doc/modules_8h.html') diff --git a/docs/module-doc/modules_8h.html b/docs/module-doc/modules_8h.html index 6110e3423..0c3cb75fd 100644 --- a/docs/module-doc/modules_8h.html +++ b/docs/module-doc/modules_8h.html @@ -78,33 +78,41 @@ #define AC_GENERAL_MODE   8 -#define FOREACH_MOD   for (int i = 0; i <= MODCOUNT; i++) modules[i]-> +#define VF_STATIC   1 -#define FOREACH_RESULT(x) +#define VF_VENDOR   2 -#define CONF_NOT_A_NUMBER   0x000010 +#define VF_SERVICEPROVIDER   4 -#define CONF_NOT_UNSIGNED   0x000080 +#define VF_COMMON   8 -#define CONF_VALUE_NOT_FOUND   0x000100 +#define FOREACH_MOD   for (int i = 0; i <= MODCOUNT; i++) modules[i]-> -#define CONF_FILE_NOT_FOUND   0x000200 +#define FOREACH_RESULT(x) + +#define CONF_NOT_A_NUMBER   0x000010 + +#define CONF_NOT_UNSIGNED   0x000080 + +#define CONF_VALUE_NOT_FOUND   0x000100 + +#define CONF_FILE_NOT_FOUND   0x000200

Typedefs

-typedef std::deque< std::string > file_cache +typedef std::deque< std::string > file_cache - Low level definition of a FileReader classes file cache area.

-typedef file_cache string_list + Low level definition of a FileReader classes file cache area.


+typedef file_cache string_list -typedef std::deque< userrec * > chanuserlist +typedef std::deque< userrec * > chanuserlist - Holds a list of users in a channel.


-typedef DLLFactory< ModuleFactoryircd_module + Holds a list of users in a channel.


+typedef DLLFactory< ModuleFactoryircd_module

Functions

-void createcommand (char *cmd, handlerfunc f, char flags, int minparams) +void createcommand (char *cmd, handlerfunc f, char flags, int minparams, char *source) -void server_mode (char **parameters, int pcnt, userrec *user) +void server_mode (char **parameters, int pcnt, userrec *user)

Define Documentation

@@ -371,7 +379,7 @@ Definition at line 39 of

Definition at line 37 of file modules.h.

-Referenced by Module::OnAccessCheck(). +Referenced by Module::OnAccessCheck().

@@ -398,7 +406,7 @@ Referenced by Module::OnAcc Definition at line 38 of file modules.h. -

+

+Referenced by ConfigReader::ConfigReader().
@@ -419,12 +427,12 @@ Definition at line 38 of

-Definition at line 667 of file modules.h. +Definition at line 677 of file modules.h.

-Referenced by ConfigReader::ConfigReader().

-

+

+Referenced by ConfigReader::ReadInteger().
@@ -445,12 +453,12 @@ Referenced by ConfigReader:

-Definition at line 664 of file modules.h. +Definition at line 674 of file modules.h.

-Referenced by ConfigReader::ReadInteger().

-

+

+Referenced by ConfigReader::ReadInteger().
@@ -471,12 +479,12 @@ Referenced by ConfigReader:

-Definition at line 665 of file modules.h. +Definition at line 675 of file modules.h.

-Referenced by ConfigReader::ReadInteger().

-

+

+Referenced by ConfigReader::ReadFlag(), ConfigReader::ReadInteger(), and ConfigReader::ReadValue().
@@ -497,9 +505,9 @@ Referenced by ConfigReader:

-Definition at line 666 of file modules.h. +Definition at line 676 of file modules.h.

-Referenced by ConfigReader::ReadFlag(), ConfigReader::ReadInteger(), and ConfigReader::ReadValue().

@@ -525,7 +533,7 @@ Referenced by ConfigReader:

Definition at line 23 of file modules.h.

-Referenced by Server::AddExtendedMode(), userrec::HasPermission(), chanrec::IsCustomModeSet(), ModeDefined(), ModeDefinedOper(), ModeIsListMode(), userrec::RemoveInvite(), chanrec::SetCustomMode(), and chanrec::SetCustomModeParam(). +Referenced by Server::AddExtendedMode(), userrec::HasPermission(), chanrec::IsCustomModeSet(), ModeDefined(), ModeDefinedOper(), ModeIsListMode(), userrec::RemoveInvite(), chanrec::SetCustomMode(), and chanrec::SetCustomModeParam().

@@ -552,7 +560,7 @@ Referenced by Server::AddEx Definition at line 25 of file modules.h. -

+

+Definition at line 79 of file modules.h.
@@ -573,10 +581,10 @@ Definition at line 25 of

-Definition at line 72 of file modules.h.

-

+

+Definition at line 87 of file modules.h.
@@ -611,7 +619,7 @@ Definition at line 72 of }

-Definition at line 80 of file modules.h.

@@ -637,7 +645,7 @@ Definition at line 80 of

Definition at line 31 of file modules.h.

-Referenced by Server::AddExtendedListMode(), and ModeMakeList(). +Referenced by Server::AddExtendedListMode(), and ModeMakeList().

@@ -663,7 +671,7 @@ Referenced by Server::AddEx

Definition at line 32 of file modules.h.

-Referenced by Server::AddExtendedMode(). +Referenced by Server::AddExtendedMode().

@@ -689,7 +697,7 @@ Referenced by Server::AddEx

Definition at line 33 of file modules.h.

-Referenced by Server::AddExtendedMode(). +Referenced by Server::AddExtendedMode().

@@ -764,14 +772,112 @@ Definition at line 26 of Definition at line 24 of file modules.h. +

+ + + + +
+ + +
#define VF_COMMON   8 +
+
+ + + + + +
+   + + +

+ +

+Definition at line 56 of file modules.h.

+

+ + + + +
+ + +
#define VF_SERVICEPROVIDER   4 +
+
+ + + + + +
+   + + +

+ +

+Definition at line 55 of file modules.h.

+

+ + + + +
+ + +
#define VF_STATIC   1 +
+
+ + + + + +
+   + + +

+ +

+Definition at line 53 of file modules.h.

+

+ + + + +
+ + +
#define VF_VENDOR   2 +
+
+ + + + + +
+   + + +

+ +

+Definition at line 54 of file modules.h. +

+Referenced by Module::GetVersion().


Typedef Documentation

-

+

@@ -788,18 +894,18 @@ Holds a list of users in a channel.

-Definition at line 65 of file modules.h. +Definition at line 72 of file modules.h.

-Referenced by Server::GetUsers(). +Referenced by Server::GetUsers().

-
typedef std::deque<userrec*> chanuserlist + typedef std::deque<userrec*> chanuserlist
-

+

@@ -816,18 +922,18 @@ Low level definition of a FileReader

-Definition at line 60 of file modules.h. +Definition at line 67 of file modules.h.

-Referenced by FileReader::FileReader(), and FileReader::LoadFile(). +Referenced by FileReader::FileReader(), and FileReader::LoadFile().

-
typedef std::deque<std::string> file_cache + typedef std::deque<std::string> file_cache
-

+

@@ -842,16 +948,16 @@ Referenced by FileReader::F

-Definition at line 832 of file modules.h. +Definition at line 842 of file modules.h.

-
typedef DLLFactory<ModuleFactory> ircd_module + typedef DLLFactory<ModuleFactory> ircd_module
-

+

@@ -866,13 +972,13 @@ Definition at line 832 of

-Definition at line 61 of file modules.h. +Definition at line 68 of file modules.h.

-Referenced by Module::OnChannelSync(), and Module::OnUserSync(). +Referenced by Module::OnChannelSync(), and Module::OnUserSync().

-
typedef file_cache string_list + typedef file_cache string_list


Function Documentation

-

+

- + + + + + + + @@ -921,10 +1033,10 @@ Referenced by Module::OnCha

-Referenced by Server::AddCommand(). +Referenced by Server::AddCommand().

@@ -899,7 +1005,13 @@ Referenced by Module::OnCha int  minparams minparams,
char *  source
-

+

+Referenced by Server::SendMode().
@@ -967,10 +1079,10 @@ Referenced by Server::AddCo

-Referenced by Server::SendMode().

-


Generated on Mon Apr 4 18:12:49 2005 for InspIRCd by +
Generated on Thu Apr 7 20:14:22 2005 for InspIRCd by doxygen 1.3.3
-- cgit v1.3.1-10-gc9f91