From 03be04a9a2d86a4568d09d5e1689dd7ef37c863a Mon Sep 17 00:00:00 2001 From: brain Date: Wed, 14 Dec 2005 14:52:12 +0000 Subject: Added extra docs for new config system git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2417 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classchanrec.html | 248 +++++++++++++++++++------------------- 1 file changed, 124 insertions(+), 124 deletions(-) (limited to 'docs/module-doc/classchanrec.html') diff --git a/docs/module-doc/classchanrec.html b/docs/module-doc/classchanrec.html index efda184a8..808cabf95 100644 --- a/docs/module-doc/classchanrec.html +++ b/docs/module-doc/classchanrec.html @@ -123,18 +123,18 @@ Creates a channel record and initialises it with default values.

-Definition at line 101 of file channels.cpp. -

-References binarymodes, created, custom_modes, internal_userlist, key, limit, name, setby, topic, and topicset.

00102 {
-00103         strcpy(name,"");
-00104         strcpy(custom_modes,"");
-00105         strcpy(topic,"");
-00106         strcpy(setby,"");
-00107         strcpy(key,"");
-00108         created = topicset = limit = 0;
-00109         binarymodes = 0;
-00110         internal_userlist.clear();
-00111 }
+Definition at line 73 of file channels.cpp.
+

+References binarymodes, created, custom_modes, internal_userlist, key, limit, name, setby, topic, and topicset.
00074 {
+00075         strcpy(name,"");
+00076         strcpy(custom_modes,"");
+00077         strcpy(topic,"");
+00078         strcpy(setby,"");
+00079         strcpy(key,"");
+00080         created = topicset = limit = 0;
+00081         binarymodes = 0;
+00082         internal_userlist.clear();
+00083 }
 

 

     
@@ -207,12 +207,12 @@ Add a user pointer to the internal reference list.
 
 The data inserted into the reference list is a table as it is an arbitary pointer compared to other users by its memory address, as this is a very fast 32 or 64 bit integer comparison.
 

-Definition at line 194 of file channels.cpp.
+Definition at line 166 of file channels.cpp.
 

-References DEBUG, and internal_userlist.
00195 {
-00196         internal_userlist.push_back(castuser);
-00197         log(DEBUG,"Added casted user to channel's internal list");
-00198 }
+References DEBUG, and internal_userlist.
00167 {
+00168         internal_userlist.push_back(castuser);
+00169         log(DEBUG,"Added casted user to channel's internal list");
+00170 }
 

 

     
@@ -252,20 +252,20 @@ Delete a user pointer to the internal reference list.
 
 The data removed from the reference list is a table as it is an arbitary pointer compared to other users by its memory address, as this is a very fast 32 or 64 bit integer comparison.
 

-Definition at line 200 of file channels.cpp.
-

-References DEBUG, internal_userlist, and name.
00201 {
-00202         for (std::vector<char*>::iterator a = internal_userlist.begin(); a < internal_userlist.end(); a++)
-00203         {
-00204                 if (*a == castuser)
-00205                 {
-00206                         log(DEBUG,"Removed casted user from channel's internal list");
-00207                         internal_userlist.erase(a);
-00208                         return;
-00209                 }
-00210         }
-00211         log(DEBUG,"BUG BUG BUG! Attempt to remove an uncasted user from the internal list of %s!",name);
-00212 }
+Definition at line 172 of file channels.cpp.
+

+References DEBUG, internal_userlist, and name.
00173 {
+00174         for (std::vector<char*>::iterator a = internal_userlist.begin(); a < internal_userlist.end(); a++)
+00175         {
+00176                 if (*a == castuser)
+00177                 {
+00178                         log(DEBUG,"Removed casted user from channel's internal list");
+00179                         internal_userlist.erase(a);
+00180                         return;
+00181                 }
+00182         }
+00183         log(DEBUG,"BUG BUG BUG! Attempt to remove an uncasted user from the internal list of %s!",name);
+00184 }
 

 

     
@@ -307,21 +307,21 @@ For example if "+L #foo" is set, and you pass this method 'L', it will return 'f
 
Returns:
The parameter for this mode is returned, or an empty string

 
 

-Definition at line 174 of file channels.cpp.
-

-References custom_mode_params.
00175 {
-00176         if (custom_mode_params.size())
-00177         {
-00178                 for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++)
-00179                 {
-00180                         if ((i->mode == mode) && (!strcasecmp(this->name,i->channel)))
-00181                         {
-00182                                 return i->parameter;
-00183                         }
-00184                 }
-00185         }
-00186         return "";
-00187 }
+Definition at line 146 of file channels.cpp.
+

+References custom_mode_params.
00147 {
+00148         if (custom_mode_params.size())
+00149         {
+00150                 for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++)
+00151                 {
+00152                         if ((i->mode == mode) && (!strcasecmp(this->name,i->channel)))
+00153                         {
+00154                                 return i->parameter;
+00155                         }
+00156                 }
+00157         }
+00158         return "";
+00159 }
 

 

     
@@ -356,9 +356,9 @@ Obtain the channel "user counter" This returns the channel reference counter, wh
 
Returns:
The number of users on this channel

 
 

-Definition at line 189 of file channels.cpp.
00190 {
-00191         return (this->internal_userlist.size());
-00192 }
+Definition at line 161 of file channels.cpp.
00162 {
+00163         return (this->internal_userlist.size());
+00164 }
 

 

     
@@ -394,13 +394,13 @@ These are used for rapid comparison to determine channel membership for PRIVMSG,
 
Returns:
This function returns a vector of userrec pointers, each of which has been casted to char* to prevent circular references

 
 

-Definition at line 214 of file channels.cpp.
+Definition at line 186 of file channels.cpp.
 

 References internal_userlist.
 

-Referenced by Server::GetUsers().
00215 {
-00216         return &internal_userlist;
-00217 }
+Referenced by Server::GetUsers().
00187 {
+00188         return &internal_userlist;
+00189 }
 

 

     
@@ -441,9 +441,9 @@ Returns true if a custom mode is set on a channel.
 
Returns:
True if the custom mode is set, false if otherwise

 
 

-Definition at line 169 of file channels.cpp.
00170 {
-00171         return (strchr(this->custom_modes,mode));
-00172 }
+Definition at line 141 of file channels.cpp.
00142 {
+00143         return (strchr(this->custom_modes,mode));
+00144 }
 

 

     
@@ -493,30 +493,30 @@ Sets or unsets a custom mode in the channels info.
 
 
 

-Definition at line 113 of file channels.cpp.
-

-References custom_modes, DEBUG, and SetCustomModeParam().
00114 {
-00115         if (mode_on) {
-00116                 static char m[3];
-00117                 m[0] = mode;
-00118                 m[1] = '\0';
-00119                 if (!strchr(this->custom_modes,mode))
-00120                 {
-00121                         strlcat(custom_modes,m,MAXMODES);
-00122                 }
-00123                 log(DEBUG,"Custom mode %c set",mode);
-00124         }
-00125         else {
-00126 
-00127                 std::string a = this->custom_modes;
-00128                 int pos = a.find(mode);
-00129                 a.erase(pos,1);
-00130                 strncpy(this->custom_modes,a.c_str(),MAXMODES);
-00131 
-00132                 log(DEBUG,"Custom mode %c removed: modelist='%s'",mode,this->custom_modes);
-00133                 this->SetCustomModeParam(mode,"",false);
-00134         }
-00135 }
+Definition at line 85 of file channels.cpp.
+

+References custom_modes, DEBUG, and SetCustomModeParam().
00086 {
+00087         if (mode_on) {
+00088                 static char m[3];
+00089                 m[0] = mode;
+00090                 m[1] = '\0';
+00091                 if (!strchr(this->custom_modes,mode))
+00092                 {
+00093                         strlcat(custom_modes,m,MAXMODES);
+00094                 }
+00095                 log(DEBUG,"Custom mode %c set",mode);
+00096         }
+00097         else {
+00098 
+00099                 std::string a = this->custom_modes;
+00100                 int pos = a.find(mode);
+00101                 a.erase(pos,1);
+00102                 strncpy(this->custom_modes,a.c_str(),MAXMODES);
+00103 
+00104                 log(DEBUG,"Custom mode %c removed: modelist='%s'",mode,this->custom_modes);
+00105                 this->SetCustomModeParam(mode,"",false);
+00106         }
+00107 }
 

 

     
@@ -573,39 +573,39 @@ Sets or unsets the parameters for a custom mode in a channels info.
 
 
 

-Definition at line 138 of file channels.cpp.
-

-References ModeParameter::channel, custom_mode_params, DEBUG, ModeParameter::mode, and ModeParameter::parameter.
-

-Referenced by SetCustomMode().
00139 {
-00140 
-00141         log(DEBUG,"SetCustomModeParam called");
-00142         ModeParameter M;
-00143         M.mode = mode;
-00144         strlcpy(M.channel,this->name,CHANMAX);
-00145         strlcpy(M.parameter,parameter,MAXBUF);
-00146         if (mode_on)
-00147         {
-00148                 log(DEBUG,"Custom mode parameter %c %s added",mode,parameter);
-00149                 custom_mode_params.push_back(M);
-00150         }
-00151         else
-00152         {
-00153                 if (custom_mode_params.size())
-00154                 {
-00155                         for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++)
-00156                         {
-00157                                 if ((i->mode == mode) && (!strcasecmp(this->name,i->channel)))
-00158                                 {
-00159                                         log(DEBUG,"Custom mode parameter %c %s removed",mode,parameter);
-00160                                         custom_mode_params.erase(i);
-00161                                         return;
-00162                                 }
-00163                         }
-00164                 }
-00165                 log(DEBUG,"*** BUG *** Attempt to remove non-existent mode parameter!");
-00166         }
-00167 }
+Definition at line 110 of file channels.cpp.
+

+References ModeParameter::channel, custom_mode_params, DEBUG, ModeParameter::mode, and ModeParameter::parameter.
+

+Referenced by SetCustomMode().
00111 {
+00112 
+00113         log(DEBUG,"SetCustomModeParam called");
+00114         ModeParameter M;
+00115         M.mode = mode;
+00116         strlcpy(M.channel,this->name,CHANMAX);
+00117         strlcpy(M.parameter,parameter,MAXBUF);
+00118         if (mode_on)
+00119         {
+00120                 log(DEBUG,"Custom mode parameter %c %s added",mode,parameter);
+00121                 custom_mode_params.push_back(M);
+00122         }
+00123         else
+00124         {
+00125                 if (custom_mode_params.size())
+00126                 {
+00127                         for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++)
+00128                         {
+00129                                 if ((i->mode == mode) && (!strcasecmp(this->name,i->channel)))
+00130                                 {
+00131                                         log(DEBUG,"Custom mode parameter %c %s removed",mode,parameter);
+00132                                         custom_mode_params.erase(i);
+00133                                         return;
+00134                                 }
+00135                         }
+00136                 }
+00137                 log(DEBUG,"*** BUG *** Attempt to remove non-existent mode parameter!");
+00138         }
+00139 }
 

 

     
@@ -665,7 +665,7 @@ Contains a bitmask of the CM_* builtin (RFC) binary mode symbols.
 

 Definition at line 145 of file channels.h.
 

-Referenced by chanrec().    
+Referenced by chanrec().    
   
 
 

@@ -694,7 +694,7 @@ Creation time.
 

 Definition at line 123 of file channels.h.
 

-Referenced by chanrec().    
+Referenced by chanrec().    
   
 
 

@@ -723,7 +723,7 @@ Plugins may use this field in any way they see fit.
 

 Definition at line 110 of file channels.h.
 

-Referenced by chanrec(), and SetCustomMode().    
+Referenced by chanrec(), and SetCustomMode().    
   
 
 

@@ -752,7 +752,7 @@ User list (casted to char*'s to stop forward declaration stuff) (chicken and egg
 

 Definition at line 115 of file channels.h.
 

-Referenced by AddUser(), chanrec(), DelUser(), and GetUsers().    
+Referenced by AddUser(), chanrec(), DelUser(), and GetUsers().    
   
 
 

@@ -781,7 +781,7 @@ If this value is an empty string, there is no channel key in place.
 

 Definition at line 141 of file channels.h.
 

-Referenced by chanrec().    
+Referenced by chanrec().    
   
 
 

@@ -810,7 +810,7 @@ If this value is zero, there is no limit in place.
 

 Definition at line 136 of file channels.h.
 

-Referenced by chanrec().    
+Referenced by chanrec().    
   
 
 

@@ -839,7 +839,7 @@ The channels name.
 

 Definition at line 106 of file channels.h.
 

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

@@ -868,7 +868,7 @@ If this member is an empty string, no topic was ever set.
 

 Definition at line 131 of file channels.h.
 

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

@@ -897,7 +897,7 @@ If this is an empty string, no channel topic is set.
 

 Definition at line 120 of file channels.h.
 

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

@@ -926,12 +926,12 @@ If no topic was ever set, this will be equal to 127 of file channels.h.
 

-Referenced by chanrec(), and Server::PseudoToUser().    
+Referenced by chanrec(), and Server::PseudoToUser().    
   
 
 
The documentation for this class was generated from the following files:
-
Generated on Mon Dec 12 18:31:01 2005 for InspIRCd by 
+
Generated on Wed Dec 14 14:49:29 2005 for InspIRCd by 
 
 doxygen 1.4.4-20050815 

 
-- 
cgit v1.2.3