From 08e384bb24398224856c44baa51b51977644de9d Mon Sep 17 00:00:00 2001 From: brain Date: Sun, 9 Feb 2003 12:49:00 +0000 Subject: Documentation update, 09/02/03 git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@167 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classModule.html | 126 ++++++++++++++++++++++++++++++++++----- 1 file changed, 110 insertions(+), 16 deletions(-) (limited to 'docs/module-doc/classModule.html') diff --git a/docs/module-doc/classModule.html b/docs/module-doc/classModule.html index b3c969821..0441e84de 100644 --- a/docs/module-doc/classModule.html +++ b/docs/module-doc/classModule.html @@ -33,6 +33,9 @@  Called when a user joins a channel.

virtual void OnUserPart (userrec *user, chanrec *channel)  Called when a user parts a channel.

+virtual void Module::OnPacketTransmit (char *p) +virtual void Module::OnPacketReceive (char *p) +virtual void OnRehash ()

Detailed Description

Base class for all InspIRCd modules This class is the base class for InspIRCd modules. @@ -41,7 +44,7 @@ All modules must inherit from this class, its methods will be called when irc se

-Definition at line 90 of file modules.h.


Constructor & Destructor Documentation

+Definition at line 65 of file modules.h.

Constructor & Destructor Documentation

@@ -71,9 +74,9 @@ Default constructor creates a module class.

-Definition at line 43 of file modules.cpp. +Definition at line 27 of file modules.cpp.

-

00043 { }
+
00027 { }
 
@@ -106,9 +109,9 @@ Default destructor destroys a module class.

-Definition at line 44 of file modules.cpp. +Definition at line 28 of file modules.cpp.

-

00044 { }
+
00028 { }
 
@@ -142,9 +145,100 @@ Returns the version number of a Module.

The method should return a Version object with its version information assigned via Version::Version

-Definition at line 49 of file modules.cpp. +Definition at line 36 of file modules.cpp.

-

00049 { return Version(1,0,0,0); }
+
00036 { return Version(1,0,0,0); }
+
+ + +

+ + + + +
+ + + + + + + + + + +
virtual void Module::Module::OnPacketReceive char *   p [virtual]
+
+ + + + + +
+   + + +

+

+

+ + + + +
+ + + + + + + + + + +
virtual void Module::Module::OnPacketTransmit char *   p [virtual]
+
+ + + + + +
+   + + +

+

+

+ + + + +
+ + + + + + + + + +
void Module::OnRehash   [virtual]
+
+ + + +
+   + + +

+ +

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

+

00035 { }
 
@@ -178,9 +272,9 @@ Called when a user connects.

The details of the connecting user are available to you in the parameter userrec *user

-Definition at line 45 of file modules.cpp. +Definition at line 29 of file modules.cpp.

-

00045 { }
+
00029 { }
 
@@ -223,9 +317,9 @@ Called when a user joins a channel.

The details of the joining user are available to you in the parameter userrec *user, and the details of the channel they have joined is available in the variable chanrec *channel

-Definition at line 47 of file modules.cpp. +Definition at line 31 of file modules.cpp.

-

00047 { }
+
00031 { }
 
@@ -268,9 +362,9 @@ Called when a user parts a channel.

The details of the leaving user are available to you in the parameter userrec *user, and the details of the channel they have left is available in the variable chanrec *channel

-Definition at line 48 of file modules.cpp. +Definition at line 32 of file modules.cpp.

-

00048 { }
+
00032 { }
 
@@ -304,15 +398,15 @@ Called when a user quits.

The details of the exiting user are available to you in the parameter userrec *user

-Definition at line 46 of file modules.cpp. +Definition at line 30 of file modules.cpp.

-

00046 { }
+
00030 { }
 

The documentation for this class was generated from the following files: -
Generated on Mon Jan 27 00:23:13 2003 for InspIRCd by +
Generated on Sun Feb 9 12:48:18 2003 for InspIRCd by doxygen1.3-rc2
-- cgit v1.3.1-10-gc9f91