From bc0d192a35489b8f5c42aa381ab2b120957ef770 Mon Sep 17 00:00:00 2001 From: brain Date: Sat, 7 May 2005 15:35:21 +0000 Subject: Added final documentation for inspircd Beta 4 git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1322 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/man/man3/modules.cpp.3 | 179 ++++++++++++++++++++++---------------------- 1 file changed, 91 insertions(+), 88 deletions(-) (limited to 'docs/man/man3/modules.cpp.3') diff --git a/docs/man/man3/modules.cpp.3 b/docs/man/man3/modules.cpp.3 index cde9a3b91..2bfbe387e 100644 --- a/docs/man/man3/modules.cpp.3 +++ b/docs/man/man3/modules.cpp.3 @@ -1,4 +1,4 @@ -.TH "modules.cpp" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "modules.cpp" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -266,6 +266,9 @@ modules.cpp \- .RI "FILE * \fBlog_file\fP" .br .ti -1c +.RI "\fBuserrec\fP * \fBfd_ref_table\fP [65536]" +.br +.ti -1c .RI "\fBuser_hash\fP \fBclientlist\fP" .br .ti -1c @@ -299,56 +302,55 @@ Definition at line 59 of file modules.cpp. .PP .SS "typedef nspace::hash_map, \fBInAddr_HashComp\fP> \fBaddress_cache\fP" .PP -Definition at line 177 of file modules.cpp. +Definition at line 178 of file modules.cpp. .SS "typedef nspace::hash_map, \fBStrHashComp\fP> \fBchan_hash\fP" .PP -Definition at line 176 of file modules.cpp. +Definition at line 177 of file modules.cpp. .SS "typedef std::deque<\fBcommand_t\fP> \fBcommand_table\fP" .PP -Definition at line 178 of file modules.cpp. +Definition at line 179 of file modules.cpp. .SS "typedef std::vector<\fBExtMode\fP> \fBExtModeList\fP" .PP -Definition at line 204 of file modules.cpp. +Definition at line 205 of file modules.cpp. .SS "typedef ExtModeList::iterator \fBExtModeListIter\fP" .PP -Definition at line 205 of file modules.cpp. +Definition at line 206 of file modules.cpp. .PP Referenced by ModeDefined(), ModeDefinedOff(), ModeDefinedOn(), ModeDefinedOper(), ModeIsListMode(), and ModeMakeList(). .SS "typedef nspace::hash_map, \fBStrHashComp\fP> \fBuser_hash\fP" .PP -Definition at line 175 of file modules.cpp. +Definition at line 176 of file modules.cpp. .SH "Function Documentation" .PP .SS "bool DoAddExtendedMode (char modechar, int type, bool requires_oper, int params_on, int params_off)" .PP -Definition at line 277 of file modules.cpp. +Definition at line 275 of file modules.cpp. .PP References EMode, and ModeDefined(). .PP Referenced by Server::AddExtendedListMode(), and Server::AddExtendedMode(). .PP .nf -278 { -279 if (ModeDefined(modechar,type)) { -280 return false; -281 } -282 EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off)); -283 return true; -284 } +276 { +277 if (ModeDefined(modechar,type)) { +278 return false; +279 } +280 EMode.push_back(ExtMode(modechar,type,requires_oper,params_on,params_off)); +281 return true; +282 } .fi .SS "std::vector<\fBircd_module\fP*> factory (255)" .PP .SS "bool ModeDefined (char modechar, int type)" .PP -Definition at line 211 of file modules.cpp. +Definition at line 212 of file modules.cpp. .PP -References DEBUG, EMode, and ExtModeListIter. +References EMode, and ExtModeListIter. .PP Referenced by DoAddExtendedMode(). .PP .nf -212 { -213 log(DEBUG,'Size of extmodes vector is %d',EMode.size()); +213 { 214 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) 215 { 216 if ((i->modechar == modechar) && (i->type == type)) @@ -361,98 +363,96 @@ Referenced by DoAddExtendedMode(). .fi .SS "int ModeDefinedOff (char modechar, int type)" .PP -Definition at line 264 of file modules.cpp. +Definition at line 262 of file modules.cpp. .PP References EMode, and ExtModeListIter. .PP .nf -265 { -266 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -267 { -268 if ((i->modechar == modechar) && (i->type == type)) -269 { -270 return i->params_when_off; -271 } -272 } -273 return 0; -274 } +263 { +264 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +265 { +266 if ((i->modechar == modechar) && (i->type == type)) +267 { +268 return i->params_when_off; +269 } +270 } +271 return 0; +272 } .fi .SS "int ModeDefinedOn (char modechar, int type)" .PP -Definition at line 251 of file modules.cpp. +Definition at line 249 of file modules.cpp. .PP References EMode, and ExtModeListIter. .PP .nf -252 { -253 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -254 { -255 if ((i->modechar == modechar) && (i->type == type)) -256 { -257 return i->params_when_on; -258 } -259 } -260 return 0; -261 } +250 { +251 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +252 { +253 if ((i->modechar == modechar) && (i->type == type)) +254 { +255 return i->params_when_on; +256 } +257 } +258 return 0; +259 } .fi .SS "bool ModeDefinedOper (char modechar, int type)" .PP -Definition at line 237 of file modules.cpp. +Definition at line 236 of file modules.cpp. .PP -References DEBUG, EMode, and ExtModeListIter. +References EMode, and ExtModeListIter. .PP .nf -238 { -239 log(DEBUG,'Size of extmodes vector is %d',EMode.size()); -240 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -241 { -242 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true)) -243 { -244 return true; -245 } -246 } -247 return false; -248 } +237 { +238 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +239 { +240 if ((i->modechar == modechar) && (i->type == type) && (i->needsoper == true)) +241 { +242 return true; +243 } +244 } +245 return false; +246 } .fi .SS "bool ModeIsListMode (char modechar, int type)" .PP Definition at line 224 of file modules.cpp. .PP -References DEBUG, EMode, and ExtModeListIter. +References EMode, and ExtModeListIter. .PP .nf 225 { -226 log(DEBUG,'Size of extmodes vector is %d',EMode.size()); -227 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -228 { -229 if ((i->modechar == modechar) && (i->type == type) && (i->list == true)) -230 { -231 return true; -232 } -233 } -234 return false; -235 } +226 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +227 { +228 if ((i->modechar == modechar) && (i->type == type) && (i->list == true)) +229 { +230 return true; +231 } +232 } +233 return false; +234 } .fi .SS "void ModeMakeList (char modechar)" .PP -Definition at line 287 of file modules.cpp. +Definition at line 285 of file modules.cpp. .PP References EMode, ExtModeListIter, and MT_CHANNEL. .PP Referenced by Server::AddExtendedListMode(). .PP .nf -288 { -289 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) -290 { -291 if ((i->modechar == modechar) && (i->type == MT_CHANNEL)) -292 { -293 i->list = true; -294 return; -295 } -296 } -297 return; -298 } +286 { +287 for (ExtModeListIter i = EMode.begin(); i < EMode.end(); i++) +288 { +289 if ((i->modechar == modechar) && (i->type == MT_CHANNEL)) +290 { +291 i->list = true; +292 return; +293 } +294 } +295 return; +296 } .fi .SS "std::vector<\fBModule\fP*> modules (255)" .PP @@ -475,15 +475,13 @@ Definition at line 103 of file modules.cpp. Definition at line 97 of file modules.cpp. .SS "\fBchan_hash\fP \fBchanlist\fP" .PP -Definition at line 182 of file modules.cpp. +Definition at line 183 of file modules.cpp. .SS "\fBuser_hash\fP \fBclientlist\fP" .PP -Definition at line 181 of file modules.cpp. -.PP -Referenced by Server::GetUsers(). +Definition at line 182 of file modules.cpp. .SS "\fBcommand_table\fP \fBcmdlist\fP" .PP -Definition at line 184 of file modules.cpp. +Definition at line 185 of file modules.cpp. .SS "std::stringstream \fBconfig_f\fP" .PP Definition at line 104 of file modules.cpp. @@ -504,7 +502,7 @@ Definition at line 77 of file modules.cpp. Definition at line 83 of file modules.cpp. .SS "\fBExtModeList\fP \fBEMode\fP" .PP -Definition at line 208 of file modules.cpp. +Definition at line 209 of file modules.cpp. .PP Referenced by DoAddExtendedMode(), ModeDefined(), ModeDefinedOff(), ModeDefinedOn(), ModeDefinedOper(), ModeIsListMode(), and ModeMakeList(). .SS "std::vector<\fBircd_module\fP*> factory" @@ -513,9 +511,14 @@ Definition at line 66 of file modules.cpp. .SS "std::vector \fBfd_reap\fP" .PP Definition at line 94 of file modules.cpp. +.SS "\fBuserrec\fP* \fBfd_ref_table\fP[65536]" +.PP +Definition at line 110 of file modules.cpp. +.PP +Referenced by Server::FindDescriptor(), and Server::PseudoToUser(). .SS "\fBaddress_cache\fP \fBIP\fP" .PP -Definition at line 187 of file modules.cpp. +Definition at line 188 of file modules.cpp. .SS "char \fBlist\fP[MAXBUF]" .PP Definition at line 81 of file modules.cpp. @@ -533,7 +536,7 @@ Definition at line 91 of file modules.cpp. Definition at line 106 of file modules.cpp. .SS "int \fBMODCOUNT\fP = -1" .PP -Definition at line 1032 of file modules.cpp. +Definition at line 1048 of file modules.cpp. .SS "std::vector \fBmodule_names\fP" .PP Definition at line 95 of file modules.cpp. @@ -542,7 +545,7 @@ Definition at line 95 of file modules.cpp. Definition at line 65 of file modules.cpp. .SS "\fBfile_cache\fP \fBMOTD\fP" .PP -Definition at line 185 of file modules.cpp. +Definition at line 186 of file modules.cpp. .SS "char \fBmotd\fP[MAXBUF]" .PP Definition at line 79 of file modules.cpp. @@ -569,7 +572,7 @@ Definition at line 82 of file modules.cpp. Definition at line 78 of file modules.cpp. .SS "\fBfile_cache\fP \fBRULES\fP" .PP -Definition at line 186 of file modules.cpp. +Definition at line 187 of file modules.cpp. .SS "char \fBrules\fP[MAXBUF]" .PP Definition at line 80 of file modules.cpp. @@ -590,7 +593,7 @@ Definition at line 68 of file modules.cpp. Definition at line 99 of file modules.cpp. .SS "\fBuser_hash\fP \fBwhowas\fP" .PP -Definition at line 183 of file modules.cpp. +Definition at line 184 of file modules.cpp. .SS "int \fBWHOWAS_MAX\fP" .PP Definition at line 87 of file modules.cpp. -- cgit v1.2.3