From f326e475e311bf0fa211ccd052ba38d8235efa12 Mon Sep 17 00:00:00 2001 From: brain Date: Fri, 1 Apr 2005 17:07:42 +0000 Subject: Updated documentation (html) git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@937 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classchanrec.html | 216 +++++++++++++++++++------------------- 1 file changed, 108 insertions(+), 108 deletions(-) (limited to 'docs/module-doc/classchanrec.html') diff --git a/docs/module-doc/classchanrec.html b/docs/module-doc/classchanrec.html index c7c0a6a1b..7cabfa142 100644 --- a/docs/module-doc/classchanrec.html +++ b/docs/module-doc/classchanrec.html @@ -116,19 +116,19 @@ Creates a channel record and initialises it with default values.

-Definition at line 111 of file channels.cpp. +Definition at line 112 of file channels.cpp.

References c_private, created, custom_modes, inviteonly, key, limit, moderated, name, noexternal, secret, setby, topic, topiclock, and topicset.

-

00112 {
-00113         strcpy(name,"");
-00114         strcpy(custom_modes,"");
-00115         strcpy(topic,"");
-00116         strcpy(setby,"");
-00117         strcpy(key,"");
-00118         created = topicset = limit = 0;
-00119         topiclock = noexternal = inviteonly = moderated = secret = c_private = false;
-00120 }
+
00113 {
+00114         strcpy(name,"");
+00115         strcpy(custom_modes,"");
+00116         strcpy(topic,"");
+00117         strcpy(setby,"");
+00118         strcpy(key,"");
+00119         created = topicset = limit = 0;
+00120         topiclock = noexternal = inviteonly = moderated = secret = c_private = false;
+00121 }
 
    
   
 
@@ -196,23 +196,23 @@ Returns the parameter for a custom mode on a channel.
 

 For example if "+L #foo" is set, and you pass this method 'L', it will return '#foo'. If the mode is not set on the channel, or the mode has no parameters associated with it, it will return an empty string.
 

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

-References custom_mode_params.
-

-
00185 {
-00186         if (custom_mode_params.size())
-00187         {
-00188                 for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++)
-00189                 {
-00190                         if ((i->mode == mode) && (!strcasecmp(this->name,i->channel)))
-00191                         {
-00192                                 return std::string(i->parameter);
-00193                         }
-00194                 }
-00195         }
-00196         return std::string("");
-00197 }
+Definition at line 185 of file channels.cpp.
+

+References custom_mode_params.
+

+
00186 {
+00187         if (custom_mode_params.size())
+00188         {
+00189                 for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++)
+00190                 {
+00191                         if ((i->mode == mode) && (!strcasecmp(this->name,i->channel)))
+00192                         {
+00193                                 return std::string(i->parameter);
+00194                         }
+00195                 }
+00196         }
+00197         return std::string("");
+00198 }
 
    
   
 
@@ -246,14 +246,14 @@ Returns true if a custom mode is set on a channel.
 

 
 

-Definition at line 178 of file channels.cpp.
+Definition at line 179 of file channels.cpp.
 

 References DEBUG.
 

-
00179 {
-00180         log(DEBUG,"Checking ISCustomModeSet: %c %s",mode,this->custom_modes);
-00181         return (strchr(this->custom_modes,mode) != 0);
-00182 }
+
00180 {
+00181         log(DEBUG,"Checking ISCustomModeSet: %c %s",mode,this->custom_modes);
+00182         return (strchr(this->custom_modes,mode) != 0);
+00183 }
 
    
   
 
@@ -296,32 +296,32 @@ Sets or unsets a custom mode in the channels info.
 

 
 

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

-References custom_modes, DEBUG, and SetCustomModeParam().
-

-
00123 {
-00124         if (mode_on) {
-00125                 char m[3];
-00126                 m[0] = mode;
-00127                 m[1] = '\0';
-00128                 if (!strchr(this->custom_modes,mode))
-00129                 {
-00130                         strlcat(custom_modes,m,MAXMODES);
-00131                 }
-00132                 log(DEBUG,"Custom mode %c set",mode);
-00133         }
-00134         else {
-00135 
-00136                 std::string a = this->custom_modes;
-00137                 int pos = a.find(mode);
-00138                 a.erase(pos,1);
-00139                 strncpy(this->custom_modes,a.c_str(),MAXMODES);
-00140 
-00141                 log(DEBUG,"Custom mode %c removed: modelist='%s'",mode,this->custom_modes);
-00142                 this->SetCustomModeParam(mode,"",false);
-00143         }
-00144 }
+Definition at line 123 of file channels.cpp.
+

+References custom_modes, DEBUG, and SetCustomModeParam().
+

+
00124 {
+00125         if (mode_on) {
+00126                 char m[3];
+00127                 m[0] = mode;
+00128                 m[1] = '\0';
+00129                 if (!strchr(this->custom_modes,mode))
+00130                 {
+00131                         strlcat(custom_modes,m,MAXMODES);
+00132                 }
+00133                 log(DEBUG,"Custom mode %c set",mode);
+00134         }
+00135         else {
+00136 
+00137                 std::string a = this->custom_modes;
+00138                 int pos = a.find(mode);
+00139                 a.erase(pos,1);
+00140                 strncpy(this->custom_modes,a.c_str(),MAXMODES);
+00141 
+00142                 log(DEBUG,"Custom mode %c removed: modelist='%s'",mode,this->custom_modes);
+00143                 this->SetCustomModeParam(mode,"",false);
+00144         }
+00145 }
 
    
   
 
@@ -370,41 +370,41 @@ Sets or unsets the parameters for a custom mode in a channels info.
 

 
 

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

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

-Referenced by SetCustomMode().
-

-
00148 {
-00149 
-00150         log(DEBUG,"SetCustomModeParam called");
-00151         ModeParameter M;
-00152         M.mode = mode;
-00153         strlcpy(M.channel,this->name,CHANMAX);
-00154         strlcpy(M.parameter,parameter,MAXBUF);
-00155         if (mode_on)
-00156         {
-00157                 log(DEBUG,"Custom mode parameter %c %s added",mode,parameter);
-00158                 custom_mode_params.push_back(M);
-00159         }
-00160         else
-00161         {
-00162                 if (custom_mode_params.size())
-00163                 {
-00164                         for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++)
-00165                         {
-00166                                 if ((i->mode == mode) && (!strcasecmp(this->name,i->channel)))
-00167                                 {
-00168                                         log(DEBUG,"Custom mode parameter %c %s removed",mode,parameter);
-00169                                         custom_mode_params.erase(i);
-00170                                         return;
-00171                                 }
-00172                         }
-00173                 }
-00174                 log(DEBUG,"*** BUG *** Attempt to remove non-existent mode parameter!");
-00175         }
-00176 }
+Definition at line 148 of file channels.cpp.
+

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

+Referenced by SetCustomMode().
+

+
00149 {
+00150 
+00151         log(DEBUG,"SetCustomModeParam called");
+00152         ModeParameter M;
+00153         M.mode = mode;
+00154         strlcpy(M.channel,this->name,CHANMAX);
+00155         strlcpy(M.parameter,parameter,MAXBUF);
+00156         if (mode_on)
+00157         {
+00158                 log(DEBUG,"Custom mode parameter %c %s added",mode,parameter);
+00159                 custom_mode_params.push_back(M);
+00160         }
+00161         else
+00162         {
+00163                 if (custom_mode_params.size())
+00164                 {
+00165                         for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++)
+00166                         {
+00167                                 if ((i->mode == mode) && (!strcasecmp(this->name,i->channel)))
+00168                                 {
+00169                                         log(DEBUG,"Custom mode parameter %c %s removed",mode,parameter);
+00170                                         custom_mode_params.erase(i);
+00171                                         return;
+00172                                 }
+00173                         }
+00174                 }
+00175                 log(DEBUG,"*** BUG *** Attempt to remove non-existent mode parameter!");
+00176         }
+00177 }
 
    
   
 
@@ -460,7 +460,7 @@ This value cannot be set at the same time as 155 of file channels.h.
 

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

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

 Definition at line 111 of file channels.h.
 

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

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

 Definition at line 103 of file channels.h.
 

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

@@ -544,7 +544,7 @@ Nonzero if the mode +i is set.
 

 Definition at line 141 of file channels.h.
 

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

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

 Definition at line 129 of file channels.h.
 

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

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

 Definition at line 124 of file channels.h.
 

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

@@ -628,7 +628,7 @@ Nonzero if the mode +m is set.
 

 Definition at line 145 of file channels.h.
 

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

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

 Definition at line 99 of file channels.h.
 

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

@@ -684,7 +684,7 @@ Nonzero if the mode +n is set.
 

 Definition at line 137 of file channels.h.
 

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

@@ -712,7 +712,7 @@ This value cannot be set at the same time as 150 of file channels.h.
 

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

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

 Definition at line 119 of file channels.h.
 

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

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

 Definition at line 108 of file channels.h.
 

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

@@ -796,7 +796,7 @@ Nonzero if the mode +t is set.
 

 Definition at line 133 of file channels.h.
 

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

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

-Referenced by chanrec().    
+Referenced by chanrec().    
   
 
 
The documentation for this class was generated from the following files:
-
Generated on Fri Mar 25 03:49:31 2005 for InspIRCd by
+
Generated on Mon Mar 28 21:09:30 2005 for InspIRCd by
 
 doxygen 
 1.3.3 

-- 
cgit v1.3.1-10-gc9f91