From 767b12b0ab6a0d4ed5f7335b26d1c0f842d99543 Mon Sep 17 00:00:00 2001 From: brain Date: Sun, 26 Jan 2003 23:52:48 +0000 Subject: Modified documentation for base classes git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@150 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/modules_8h-source.html | 209 +++++++++++++++++---------------- 1 file changed, 105 insertions(+), 104 deletions(-) (limited to 'docs/module-doc/modules_8h-source.html') diff --git a/docs/module-doc/modules_8h-source.html b/docs/module-doc/modules_8h-source.html index 6c4a1e489..6d1bafadd 100644 --- a/docs/module-doc/modules_8h-source.html +++ b/docs/module-doc/modules_8h-source.html @@ -9,8 +9,8 @@

modules.h

Go to the documentation of this file.
00001 /*
 00002 
 00003 $Log$
-00003 Revision 1.2  2003/01/23 20:38:00  brain
-00003 Updated documentation scripts
+00003 Revision 1.3  2003/01/26 23:52:48  brain
+00003 Modified documentation for base classes
 00003 
 00004 Revision 1.1.1.1  2003/01/23 19:45:58  brain
 00005 InspIRCd second source tree
@@ -47,114 +47,115 @@
 00036 #define __PLUGIN_H
 00037 
 00038 #include "dynamic.h"
-00039 #include <string>
-00040 #include <deque>
-00041 
-00044 typedef deque<string> file_cache;
-00045 
+00039 #include "base.h"
+00040 #include <string>
+00041 #include <deque>
+00042 
+00045 typedef deque<string> file_cache;
 00046 
-00047 // This #define allows us to call a method in all
-00048 // loaded modules in a readable simple way, e.g.:
-00049 // 'FOREACH_MOD OnConnect(user);'
-00050 
-00051 #define FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]->
-00052 
-00053 // class Version holds the version information of a Module, returned
-00054 // by Module::GetVersion (thanks RD)
-00055 
-00060 class Version
-00061 {
-00062  public:
-00063          const int Major, Minor, Revision, Build;
-00064          Version(int major, int minor, int revision, int build);
-00065 };
-00066 
+00047 
+00048 // This #define allows us to call a method in all
+00049 // loaded modules in a readable simple way, e.g.:
+00050 // 'FOREACH_MOD OnConnect(user);'
+00051 
+00052 #define FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]->
+00053 
+00054 // class Version holds the version information of a Module, returned
+00055 // by Module::GetVersion (thanks RD)
+00056 
+00061 class Version : public classbase
+00062 {
+00063  public:
+00064          const int Major, Minor, Revision, Build;
+00065          Version(int major, int minor, int revision, int build);
+00066 };
 00067 
-00073 class Admin
-00074 {
-00075  public:
-00076          const string Name, Email, Nick;
-00077          Admin(string name,string email,string nick);
-00078 };
-00079 
-00085 class Module
-00086 {
-00087  public:
-00091         Module();
-00095         virtual ~Module();
-00100         virtual Version GetVersion();
-00104         virtual void OnUserConnect(userrec* user);
-00108         virtual void OnUserQuit(userrec* user);
-00113         virtual void OnUserJoin(userrec* user, chanrec* channel);
-00118         virtual void OnUserPart(userrec* user, chanrec* channel);
-00119 };
-00120 
+00068 
+00074 class Admin : public classbase
+00075 {
+00076  public:
+00077          const string Name, Email, Nick;
+00078          Admin(string name,string email,string nick);
+00079 };
+00080 
+00086 class Module : public classbase
+00087 {
+00088  public:
+00092         Module();
+00096         virtual ~Module();
+00101         virtual Version GetVersion();
+00105         virtual void OnUserConnect(userrec* user);
+00109         virtual void OnUserQuit(userrec* user);
+00114         virtual void OnUserJoin(userrec* user, chanrec* channel);
+00119         virtual void OnUserPart(userrec* user, chanrec* channel);
+00120 };
 00121 
-00127 class Server
-00128 {
-00129  public:
-00133         Server();
-00137         virtual ~Server();
-00138 
-00142         virtual void SendOpers(string s);
-00147         virtual void Debug(string s);
-00152         virtual void Send(int Socket, string s);
-00157         virtual void SendServ(int Socket, string s);
-00162         virtual void SendFrom(int Socket, userrec* User, string s);
-00167         virtual void SendTo(userrec* Source, userrec* Dest, string s);
-00174         virtual void SendChannel(userrec* User, chanrec* Channel, string s,bool IncludeSender);
-00179         virtual bool CommonChannels(userrec* u1, userrec* u2);
-00187         virtual void SendCommon(userrec* User, string text,bool IncludeSender);
-00192         virtual void SendWallops(userrec* User, string text);
-00193 
-00197         virtual bool IsNick(string nick);
-00201         virtual userrec* FindNick(string nick);
-00205         virtual chanrec* FindChannel(string channel);
-00210         virtual string ChanMode(userrec* User, chanrec* Chan);
-00213         virtual string GetServerName();
-00216         virtual string GetNetworkName();
-00222         virtual Admin GetAdmin();
-00223          
-00224 };
-00225 
-00232 class ConfigReader
-00233 {
-00234   protected:
-00237         string fname;
-00238   public:
-00243         ConfigReader();                 // default constructor reads ircd.conf
-00247         ConfigReader(string filename);  // read a module-specific config
-00251         ~ConfigReader();
-00256         string ReadValue(string tag, string name, int index);
-00263         int Enumerate(string tag);
-00267         bool Verify();
-00268 };
-00269 
+00122 
+00128 class Server : public classbase
+00129 {
+00130  public:
+00134         Server();
+00138         virtual ~Server();
+00139 
+00143         virtual void SendOpers(string s);
+00148         virtual void Debug(string s);
+00153         virtual void Send(int Socket, string s);
+00158         virtual void SendServ(int Socket, string s);
+00163         virtual void SendFrom(int Socket, userrec* User, string s);
+00168         virtual void SendTo(userrec* Source, userrec* Dest, string s);
+00175         virtual void SendChannel(userrec* User, chanrec* Channel, string s,bool IncludeSender);
+00180         virtual bool CommonChannels(userrec* u1, userrec* u2);
+00188         virtual void SendCommon(userrec* User, string text,bool IncludeSender);
+00193         virtual void SendWallops(userrec* User, string text);
+00194 
+00198         virtual bool IsNick(string nick);
+00202         virtual userrec* FindNick(string nick);
+00206         virtual chanrec* FindChannel(string channel);
+00211         virtual string ChanMode(userrec* User, chanrec* Chan);
+00214         virtual string GetServerName();
+00217         virtual string GetNetworkName();
+00223         virtual Admin GetAdmin();
+00224          
+00225 };
+00226 
+00233 class ConfigReader : public classbase
+00234 {
+00235   protected:
+00238         string fname;
+00239   public:
+00244         ConfigReader();                 // default constructor reads ircd.conf
+00248         ConfigReader(string filename);  // read a module-specific config
+00252         ~ConfigReader();
+00257         string ReadValue(string tag, string name, int index);
+00264         int Enumerate(string tag);
+00268         bool Verify();
+00269 };
 00270 
 00271 
-00277 class FileReader
-00278 {
-00279  file_cache fc;
-00280  public:
-00285          FileReader();
-00291          FileReader(string filename);
-00295          ~FileReader();
-00301          void LoadFile(string filename);
-00306          string GetLine(int x);
-00312          int FileSize();
-00313 };
-00314 
+00272 
+00278 class FileReader : public classbase
+00279 {
+00280  file_cache fc;
+00281  public:
+00286          FileReader();
+00292          FileReader(string filename);
+00296          ~FileReader();
+00302          void LoadFile(string filename);
+00307          string GetLine(int x);
+00313          int FileSize();
+00314 };
 00315 
-00322 class ModuleFactory
-00323 {
-00324  public:
-00325         ModuleFactory() { }
-00326         virtual ~ModuleFactory() { }
-00331         virtual Module * CreateModule() = 0;
-00332 };
-00333 
-00334 #endif
-
Generated on Thu Jan 23 20:28:57 2003 for InspIRCd by +00316 +00323 class ModuleFactory : public classbase +00324 { +00325 public: +00326 ModuleFactory() { } +00327 virtual ~ModuleFactory() { } +00332 virtual Module * CreateModule() = 0; +00333 }; +00334 +00335 #endif +
Generated on Sun Jan 26 23:45:47 2003 for InspIRCd by doxygen1.3-rc2
-- cgit v1.2.3