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/classchanrec.html | 280 +++++++++++++++++++------------------- 1 file changed, 143 insertions(+), 137 deletions(-) (limited to 'docs/module-doc/classchanrec.html') diff --git a/docs/module-doc/classchanrec.html b/docs/module-doc/classchanrec.html index eaa2780f0..97d321cf6 100644 --- a/docs/module-doc/classchanrec.html +++ b/docs/module-doc/classchanrec.html @@ -94,7 +94,7 @@ This class represents a channel, and contains its name, modes, time created, top

-Definition at line 101 of file channels.h.

Constructor & Destructor Documentation

+Definition at line 103 of file channels.h.

Constructor & Destructor Documentation

@@ -123,18 +123,18 @@ Creates a channel record and initialises it with default values.

-Definition at line 73 of file channels.cpp. +Definition at line 74 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 }
+References binarymodes, created, custom_modes, internal_userlist, key, limit, name, setby, topic, and topicset.
00075 {
+00076         strcpy(name,"");
+00077         strcpy(custom_modes,"");
+00078         strcpy(topic,"");
+00079         strcpy(setby,"");
+00080         strcpy(key,"");
+00081         created = topicset = limit = 0;
+00082         binarymodes = 0;
+00083         internal_userlist.clear();
+00084 }
 

 

     
@@ -166,7 +166,7 @@ References binarymodes,
 

 
 

-Definition at line 224 of file channels.h.
00224 { /* stub */ }
+Definition at line 226 of file channels.h.
00226 { /* stub */ }
 

 

     
@@ -207,12 +207,14 @@ 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 166 of file channels.cpp.
+Definition at line 167 of file channels.cpp.
 

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

+Referenced by ForceChan().
00168 {
+00169         internal_userlist.push_back(castuser);
+00170         log(DEBUG,"Added casted user to channel's internal list");
+00171 }
 

 

     
@@ -252,20 +254,22 @@ 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 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 }
+Definition at line 173 of file channels.cpp.
+

+References DEBUG, internal_userlist, log(), and name.
+

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

 

     
@@ -307,21 +311,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 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 }
+Definition at line 147 of file channels.cpp.
+

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

 

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

 
 

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

 

     
@@ -394,13 +398,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 186 of file channels.cpp.
+Definition at line 187 of file channels.cpp.
 

-References internal_userlist.
+References internal_userlist.
 

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

 

     
@@ -441,9 +445,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 141 of file channels.cpp.
00142 {
-00143         return (strchr(this->custom_modes,mode));
-00144 }
+Definition at line 142 of file channels.cpp.
00143 {
+00144         return (strchr(this->custom_modes,mode));
+00145 }
 

 

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

-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 }
+Definition at line 86 of file channels.cpp.
+

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

 

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

-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 }
+Definition at line 111 of file channels.cpp.
+

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

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

 

     
@@ -636,7 +640,9 @@ The list of all bans set on the channel.
 

 
 

-Definition at line 149 of file channels.h.    
+Definition at line 151 of file channels.h.
+

+Referenced by add_channel().

@@ -663,9 +669,9 @@ Contains a bitmask of the CM_* builtin (RFC) binary mode symbols.

-Definition at line 145 of file channels.h. +Definition at line 147 of file channels.h.

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

@@ -692,9 +698,9 @@ Creation time.

-Definition at line 123 of file channels.h. +Definition at line 125 of file channels.h.

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

@@ -721,9 +727,9 @@ Custom modes for the channel.

Plugins may use this field in any way they see fit.

-Definition at line 110 of file channels.h. +Definition at line 112 of file channels.h.

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

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

-Definition at line 115 of file channels.h. +Definition at line 117 of file channels.h.

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

@@ -779,9 +785,9 @@ Contains the channel key.

If this value is an empty string, there is no channel key in place.

-Definition at line 141 of file channels.h. +Definition at line 143 of file channels.h.

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

@@ -808,9 +814,9 @@ Contains the channel user limit.

If this value is zero, there is no limit in place.

-Definition at line 136 of file channels.h. +Definition at line 138 of file channels.h.

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

@@ -837,9 +843,9 @@ The channels name.

-Definition at line 106 of file channels.h. +Definition at line 108 of file channels.h.

-Referenced by chanrec(), DelUser(), and Server::PseudoToUser(). +Referenced by add_channel(), chanrec(), del_channel(), DelUser(), ForceChan(), kick_channel(), and Server::PseudoToUser().

@@ -866,9 +872,9 @@ The last user to set the topic.

If this member is an empty string, no topic was ever set.

-Definition at line 131 of file channels.h. +Definition at line 133 of file channels.h.

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

@@ -895,9 +901,9 @@ Channel topic.

If this is an empty string, no channel topic is set.

-Definition at line 120 of file channels.h. +Definition at line 122 of file channels.h.

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

@@ -924,14 +930,14 @@ Time topic was set.

If no topic was ever set, this will be equal to chanrec::created

-Definition at line 127 of file channels.h. +Definition at line 129 of file channels.h.

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

The documentation for this class was generated from the following files: -
Generated on Wed Dec 14 15:55:48 2005 for InspIRCd by  +
Generated on Wed Dec 14 19:16:26 2005 for InspIRCd by  doxygen 1.4.4-20050815
-- cgit v1.2.3