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/channels_8h-source.html | 222 ++++++++++++++++---------------- 1 file changed, 114 insertions(+), 108 deletions(-) (limited to 'docs/module-doc/channels_8h-source.html') diff --git a/docs/module-doc/channels_8h-source.html b/docs/module-doc/channels_8h-source.html index b97c331ba..d2ae71063 100644 --- a/docs/module-doc/channels_8h-source.html +++ b/docs/module-doc/channels_8h-source.html @@ -39,116 +39,122 @@ 00030 #define CM_SECRET 16 00031 #define CM_PRIVATE 32 00032 -00036 class HostItem : public classbase -00037 { -00038 public: -00039 time_t set_time; -00040 char set_by[NICKMAX]; -00041 char data[MAXBUF]; -00042 -00043 HostItem() { /* stub */ } -00044 virtual ~HostItem() { /* stub */ } -00045 }; -00046 -00047 // banlist is inherited from HostList mainly for readability -00048 // reasons only -00049 -00052 class BanItem : public HostItem -00053 { -00054 }; -00055 -00056 // same with this... +00033 class userrec; +00034 +00038 class HostItem : public classbase +00039 { +00040 public: +00041 time_t set_time; +00042 char set_by[NICKMAX]; +00043 char data[MAXBUF]; +00044 +00045 HostItem() { /* stub */ } +00046 virtual ~HostItem() { /* stub */ } +00047 }; +00048 +00049 // banlist is inherited from HostList mainly for readability +00050 // reasons only +00051 +00054 class BanItem : public HostItem +00055 { +00056 }; 00057 -00060 class ExemptItem : public HostItem -00061 { -00062 }; -00063 -00064 // and this... +00058 // same with this... +00059 +00062 class ExemptItem : public HostItem +00063 { +00064 }; 00065 -00068 class InviteItem : public HostItem -00069 { -00070 }; -00071 -00072 -00077 class ModeParameter : public classbase -00078 { -00079 public: -00080 char mode; -00081 char parameter[MAXBUF]; -00082 char channel[CHANMAX]; -00083 }; -00084 -00087 typedef std::vector<BanItem> BanList; -00088 -00091 typedef std::vector<ExemptItem> ExemptList; -00092 -00095 typedef std::vector<InviteItem> InviteList; -00096 -00101 class chanrec : public Extensible -00102 { -00103 public: -00106 char name[CHANMAX]; /* channel name */ -00110 char custom_modes[MAXMODES]; /* modes handled by modules */ -00111 -00115 std::vector<char*> internal_userlist; -00116 -00120 char topic[MAXBUF]; -00123 time_t created; -00127 time_t topicset; -00131 char setby[NICKMAX]; -00132 -00136 short int limit; -00137 -00141 char key[32]; -00142 -00145 char binarymodes; -00146 -00149 BanList bans; -00150 -00155 void SetCustomMode(char mode,bool mode_on); -00156 -00162 void SetCustomModeParam(char mode,char* parameter,bool mode_on); -00163 -00168 bool IsCustomModeSet(char mode); -00169 -00180 std::string GetModeParameter(char mode); -00181 -00189 long GetUserCounter(); -00190 -00198 void AddUser(char* castuser); -00199 -00207 void DelUser(char* castuser); -00208 -00218 std::vector<char*> *GetUsers(); -00219 -00222 chanrec(); -00223 -00224 virtual ~chanrec() { /* stub */ } -00225 }; -00226 -00227 /* used to hold a channel and a users modes on that channel, e.g. +v, +h, +o -00228 * needs to come AFTER struct chanrec */ -00229 -00230 #define UCMODE_OP 1 -00231 #define UCMODE_VOICE 2 -00232 #define UCMODE_HOP 4 -00233 #define UCMODE_PROTECT 8 -00234 #define UCMODE_FOUNDER 16 -00235 -00241 class ucrec : public classbase -00242 { -00243 public: -00247 char uc_modes; -00248 -00252 chanrec *channel; -00253 -00254 ucrec() { /* stub */ } -00255 virtual ~ucrec() { /* stub */ } -00256 }; -00257 -00258 #endif -00259 -
Generated on Wed Dec 14 15:55:46 2005 for InspIRCd by  +00066 // and this... +00067 +00070 class InviteItem : public HostItem +00071 { +00072 }; +00073 +00074 +00079 class ModeParameter : public classbase +00080 { +00081 public: +00082 char mode; +00083 char parameter[MAXBUF]; +00084 char channel[CHANMAX]; +00085 }; +00086 +00089 typedef std::vector<BanItem> BanList; +00090 +00093 typedef std::vector<ExemptItem> ExemptList; +00094 +00097 typedef std::vector<InviteItem> InviteList; +00098 +00103 class chanrec : public Extensible +00104 { +00105 public: +00108 char name[CHANMAX]; /* channel name */ +00112 char custom_modes[MAXMODES]; /* modes handled by modules */ +00113 +00117 std::vector<char*> internal_userlist; +00118 +00122 char topic[MAXBUF]; +00125 time_t created; +00129 time_t topicset; +00133 char setby[NICKMAX]; +00134 +00138 short int limit; +00139 +00143 char key[32]; +00144 +00147 char binarymodes; +00148 +00151 BanList bans; +00152 +00157 void SetCustomMode(char mode,bool mode_on); +00158 +00164 void SetCustomModeParam(char mode,char* parameter,bool mode_on); +00165 +00170 bool IsCustomModeSet(char mode); +00171 +00182 std::string GetModeParameter(char mode); +00183 +00191 long GetUserCounter(); +00192 +00200 void AddUser(char* castuser); +00201 +00209 void DelUser(char* castuser); +00210 +00220 std::vector<char*> *GetUsers(); +00221 +00224 chanrec(); +00225 +00226 virtual ~chanrec() { /* stub */ } +00227 }; +00228 +00229 /* used to hold a channel and a users modes on that channel, e.g. +v, +h, +o +00230 * needs to come AFTER struct chanrec */ +00231 +00232 #define UCMODE_OP 1 +00233 #define UCMODE_VOICE 2 +00234 #define UCMODE_HOP 4 +00235 #define UCMODE_PROTECT 8 +00236 #define UCMODE_FOUNDER 16 +00237 +00243 class ucrec : public classbase +00244 { +00245 public: +00249 char uc_modes; +00250 +00254 chanrec *channel; +00255 +00256 ucrec() { /* stub */ } +00257 virtual ~ucrec() { /* stub */ } +00258 }; +00259 +00260 chanrec* add_channel(userrec *user, const char* cn, const char* key, bool override); +00261 chanrec* del_channel(userrec *user, const char* cname, const char* reason, bool local); +00262 void kick_channel(userrec *src,userrec *user, chanrec *Ptr, char* reason); +00263 +00264 #endif +00265 +
Generated on Wed Dec 14 19:16:11 2005 for InspIRCd by  doxygen 1.4.4-20050815
-- cgit v1.2.3