From 4d6d3859d208d5576e7149de9a0a5576b7cf5153 Mon Sep 17 00:00:00 2001 From: brain Date: Mon, 12 Dec 2005 18:31:52 +0000 Subject: Added extra documentation for InspSocket (at last) git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2356 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classchanrec.html | 97 +++++++++++++++++++-------------------- 1 file changed, 47 insertions(+), 50 deletions(-) (limited to 'docs/module-doc/classchanrec.html') diff --git a/docs/module-doc/classchanrec.html b/docs/module-doc/classchanrec.html index c002e97f0..efda184a8 100644 --- a/docs/module-doc/classchanrec.html +++ b/docs/module-doc/classchanrec.html @@ -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 195 of file channels.cpp. +Definition at line 194 of file channels.cpp.

-References DEBUG, and internal_userlist.

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

 

     
@@ -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 201 of file channels.cpp.
-

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

 

     
@@ -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 175 of file channels.cpp.
-

-References custom_mode_params.
00176 {
-00177         if (custom_mode_params.size())
-00178         {
-00179                 for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++)
-00180                 {
-00181                         if ((i->mode == mode) && (!strcasecmp(this->name,i->channel)))
-00182                         {
-00183                                 return i->parameter;
-00184                         }
-00185                 }
-00186         }
-00187         return "";
-00188 }
+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 }
 

 

     
@@ -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 190 of file channels.cpp.
00191 {
-00192         return (this->internal_userlist.size());
-00193 }
+Definition at line 189 of file channels.cpp.
00190 {
+00191         return (this->internal_userlist.size());
+00192 }
 

 

     
@@ -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 215 of file channels.cpp.
+Definition at line 214 of file channels.cpp.
 

 References internal_userlist.
 

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

 

     
@@ -441,12 +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.
-

-References DEBUG.
00170 {
-00171         log(DEBUG,"Checking ISCustomModeSet: %c %s",mode,this->custom_modes);
-00172         return (strchr(this->custom_modes,mode) != 0);
-00173 }
+Definition at line 169 of file channels.cpp.
00170 {
+00171         return (strchr(this->custom_modes,mode));
+00172 }
 

 

     
@@ -755,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().    
   
 
 

@@ -842,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().    
   
 
 

@@ -934,7 +931,7 @@ Referenced by chanrec()
 
The documentation for this class was generated from the following files:
-
Generated on Mon Dec 12 13:31:11 2005 for InspIRCd by 
+
Generated on Mon Dec 12 18:31:01 2005 for InspIRCd by 
 
 doxygen 1.4.4-20050815 

 
-- 
cgit v1.2.3