From a96514c284514116300794696f062c7fa6b1f79f Mon Sep 17 00:00:00 2001 From: brain Date: Wed, 14 Dec 2005 19:17:41 +0000 Subject: Added new docs for class InspIRCd and globals.h etc git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2451 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/modules_8h.html | 389 +++++++++++++++++++++++++++++++++++++--- 1 file changed, 361 insertions(+), 28 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 82ac53cf0..4fd576a85 100644 --- a/docs/module-doc/modules_8h.html +++ b/docs/module-doc/modules_8h.html @@ -18,17 +18,18 @@

Include dependency graph for modules.h:

- - - + + + +

This graph shows which files directly or indirectly include this file:

- - - + + +

@@ -55,7 +56,7 @@ This graph shows which files directly or indirectly include this file:

 Holds an extended mode's details. More...
class  Module - Base class for all InspIRCd modules This class is the base class for InspIRCd modules. More...
+ Base class for all InspIRCd modules This class is the base class for InspIRCd modules. More...
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. More...
@@ -139,7 +140,7 @@ This graph shows which files directly or indirectly include this file:

typedef std::deque< std::string > file_cache  Low level definition of a FileReader classes file cache area.
-typedef file_cache string_list +typedef file_cache string_list typedef std::deque< userrec * > chanuserlist @@ -147,10 +148,22 @@ This graph shows which files directly or indirectly include this file:

typedef DLLFactory< ModuleFactory > ircd_module

Functions

-void createcommand (char *cmd, handlerfunc f, char flags, int minparams, char *source) +void createcommand (char *cmd, handlerfunc f, char flags, int minparams, char *source) void server_mode (char **parameters, int pcnt, userrec *user) +bool ModeDefined (char c, int i) + +bool ModeDefinedOper (char c, int i) + +int ModeDefinedOn (char c, int i) + +int ModeDefinedOff (char c, int i) + +void ModeMakeList (char modechar) + +bool ModeIsListMode (char modechar, int type) +

Define Documentation

@@ -325,7 +338,9 @@ Definition at line 47 of

-Definition at line 40 of file modules.h. +Definition at line 40 of file modules.h. +

+Referenced by kick_channel().

@@ -429,7 +444,7 @@ Used with OnAccessCheck() method of modules.

Definition at line 37 of file modules.h.

-Referenced by Module::OnAccessCheck(). +Referenced by kick_channel(), and Module::OnAccessCheck().

@@ -454,7 +469,9 @@ Referenced by Module::OnAcc

-Definition at line 38 of file modules.h. +Definition at line 38 of file modules.h. +

+Referenced by kick_channel().

@@ -481,7 +498,7 @@ Definition at line 38 of

Definition at line 1520 of file modules.h.

-Referenced by ConfigReader::ConfigReader(). +Referenced by ConfigReader::ConfigReader().

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

Definition at line 1517 of file modules.h.

-Referenced by ConfigReader::ReadInteger(). +Referenced by ConfigReader::ReadInteger().

@@ -535,7 +552,7 @@ Referenced by ConfigReader:

Definition at line 1518 of file modules.h.

-Referenced by ConfigReader::ReadInteger(). +Referenced by ConfigReader::ReadInteger().

@@ -562,7 +579,7 @@ Referenced by ConfigReader:

Definition at line 1519 of file modules.h.

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

@@ -641,7 +658,7 @@ Definition at line 25 of

Definition at line 101 of file modules.h.

-Referenced by Server::PseudoToUser(), and Server::UserToPseudo(). +Referenced by Server::PseudoToUser(), and Server::UserToPseudo().

@@ -668,7 +685,7 @@ Referenced by Server::Pseud

Definition at line 81 of file modules.h.

-Referenced by Event::Send(). +Referenced by del_channel(), ForceChan(), kick_channel(), and Event::Send().

@@ -707,7 +724,9 @@ Referenced by Event::Send() }

-Definition at line 89 of file modules.h. +Definition at line 89 of file modules.h. +

+Referenced by add_channel(), and kick_channel().

@@ -736,7 +755,7 @@ Used with OnExtendedMode() method of modules.

Definition at line 31 of file modules.h.

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

@@ -763,7 +782,7 @@ Referenced by Server::AddEx

Definition at line 32 of file modules.h.

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

@@ -790,7 +809,7 @@ Referenced by Server::AddEx

Definition at line 33 of file modules.h.

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

@@ -969,7 +988,7 @@ Definition at line 52 of

Definition at line 53 of file modules.h.

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

Typedef Documentation

@@ -1006,7 +1025,7 @@ Definition at line 74 of - +
typedef std::deque<std::string> file_cache typedef std::deque<std::string> file_cache
@@ -1058,7 +1077,7 @@ Definition at line 1686 o - +
typedef file_cache string_list typedef file_cache string_list
@@ -1092,7 +1111,7 @@ Definition at line 70 of - handlerfunc  + handlerfunc  f, @@ -1132,7 +1151,321 @@ Definition at line 70 of

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

+ + + + +
+ + + + + + + + + + + + + + + + + + +
bool ModeDefined ( char  c,
int  i
) 
+
+ + + + + +
+   + + +

+ +

+Definition at line 71 of file modules.cpp. +

+References EMode. +

+Referenced by DoAddExtendedMode().

00072 {
+00073         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00074         {
+00075                 if ((i->modechar == modechar) && (i->type == type))
+00076                 {
+00077                         return true;
+00078                 }
+00079         }
+00080         return false;
+00081 }
+
+

+

+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
int ModeDefinedOff ( char  c,
int  i
) 
+
+ + + + + +
+   + + +

+ +

+Definition at line 121 of file modules.cpp. +

+References EMode.

00122 {
+00123         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00124         {
+00125                 if ((i->modechar == modechar) && (i->type == type))
+00126                 {
+00127                         return i->params_when_off;
+00128                 }
+00129         }
+00130         return 0;
+00131 }
+
+

+

+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
int ModeDefinedOn ( char  c,
int  i
) 
+
+ + + + + +
+   + + +

+ +

+Definition at line 108 of file modules.cpp. +

+References EMode.

00109 {
+00110         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00111         {
+00112                 if ((i->modechar == modechar) && (i->type == type))
+00113                 {
+00114                         return i->params_when_on;
+00115                 }
+00116         }
+00117         return 0;
+00118 }
+
+

+

+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
bool ModeDefinedOper ( char  c,
int  i
) 
+
+ + + + + +
+   + + +

+ +

+Definition at line 95 of file modules.cpp. +

+References EMode.

00096 {
+00097         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00098         {
+00099                 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true))
+00100                 {
+00101                         return true;
+00102                 }
+00103         }
+00104         return false;
+00105 }
+
+

+

+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
bool ModeIsListMode ( char  modechar,
int  type
) 
+
+ + + + + +
+   + + +

+ +

+Definition at line 83 of file modules.cpp. +

+References EMode.

00084 {
+00085         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00086         {
+00087                 if ((i->modechar == modechar) && (i->type == type) && (i->list == true))
+00088                 {
+00089                         return true;
+00090                 }
+00091         }
+00092         return false;
+00093 }
+
+

+

+

+ + + + +
+ + + + + + + + + +
void ModeMakeList ( char  modechar  ) 
+
+ + + +
+   + + +

+ +

+Definition at line 144 of file modules.cpp. +

+References EMode, and MT_CHANNEL. +

+Referenced by Server::AddExtendedListMode().

00145 {
+00146         for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++)
+00147         {
+00148                 if ((i->modechar == modechar) && (i->type == MT_CHANNEL))
+00149                 {
+00150                         i->list = true;
+00151                         return;
+00152                 }
+00153         }
+00154         return;
+00155 }
+
+

+

@@ -1178,7 +1511,7 @@ Referenced by Server::AddCo -

Generated on Wed Dec 14 15:55:47 2005 for InspIRCd by  +
Generated on Wed Dec 14 19:16:21 2005 for InspIRCd by  doxygen 1.4.4-20050815
-- cgit v1.2.3