From 5f3d7cc64f6f71fff52166dd6488f2df0378375b Mon Sep 17 00:00:00 2001 From: brain Date: Wed, 25 May 2005 22:04:11 +0000 Subject: Changed documentation to add parameters git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1523 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classchanrec.html | 61 ++++++++++++++++++++++++++++++++------- 1 file changed, 50 insertions(+), 11 deletions(-) (limited to 'docs/module-doc/classchanrec.html') diff --git a/docs/module-doc/classchanrec.html b/docs/module-doc/classchanrec.html index 27b3373df..412bde3bb 100644 --- a/docs/module-doc/classchanrec.html +++ b/docs/module-doc/classchanrec.html @@ -40,10 +40,10 @@ Inheritance diagram for chanrec:

 Obtain the channel "user counter" This returns the channel reference counter, which is initialized to 0 when the channel is created and incremented/decremented upon joins, parts quits and kicks.

void AddUser (char *castuser) - 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.

+ Add a user pointer to the internal reference list.

void DelUser (char *castuser) - 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.

+ Delete a user pointer to the internal reference list.

std::vector< char * > * GetUsers ()  Obrain the internal reference list The internal reference list contains a list of userrec* cast to char*.

@@ -168,9 +168,9 @@ References binarymodes,

-Definition at line 205 of file channels.h. +Definition at line 224 of file channels.h.

-

00205 { /* stub */ }
+
00224 { /* stub */ }
 
    
   
 
@@ -201,9 +201,14 @@ Definition at line 205 o
     
 
 

-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. 
+Add a user pointer to the internal reference list. 
 

-
+
Parameters:

+  
+    
+  
castuser This should be a pointer to a userrec, casted to char*

+

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

@@ -242,9 +247,14 @@ References DEBUG, and 
 
 

-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. 
+Delete a user pointer to the internal reference list. 
 

-
+
Parameters:

+  
+    
+  
castuser This should be a pointer to a userrec, casted to char*

+

+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 207 of file channels.cpp.
 

@@ -293,7 +303,14 @@ References DEBUG, 
 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.
+
Parameters:

+  
+    
+  
mode The mode character you wish to query

+

+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.

+
Returns:
The parameter for this mode is returned, or an empty string

+
 

 Definition at line 181 of file channels.cpp.
 

@@ -342,6 +359,7 @@ References custom_mode_par
 

 Obtain the channel "user counter" This returns the channel reference counter, which is initialized to 0 when the channel is created and incremented/decremented upon joins, parts quits and kicks. 
 

+
Returns:
The number of users on this channel

 
 

 Definition at line 196 of file channels.cpp.
@@ -381,7 +399,9 @@ References internal_userlist
 

 Obrain the internal reference list The internal reference list contains a list of userrec* cast to char*. 
 

-These are used for rapid comparison to determine channel membership for PRIVMSG, NOTICE, QUIT, PART etc. The resulting pointer to the vector should be considered readonly and only modified via AddUser and DelUser.
+These are used for rapid comparison to determine channel membership for PRIVMSG, NOTICE, QUIT, PART etc. The resulting pointer to the vector should be considered readonly and only modified via AddUser and DelUser.

+
Returns:
This function returns a vector of userrec pointers, each of which has been casted to char* to prevent circular references

+
 

 Definition at line 221 of file channels.cpp.
 

@@ -423,6 +443,12 @@ Referenced by Server::GetUs
 

 Returns true if a custom mode is set on a channel. 
 

+
Parameters:

+  
+    
+  
mode The mode character you wish to query 

+

+
Returns:
True if the custom mode is set, false if otherwise

 
 

 Definition at line 175 of file channels.cpp.
@@ -473,6 +499,12 @@ References DEBUG.
 

 Sets or unsets a custom mode in the channels info. 
 

+
Parameters:

+  
+    
+    
+  
mode The mode character to set or unset 
mode_on True if you want to set the mode or false if you want to remove it

+

 
 

 Definition at line 119 of file channels.cpp.
@@ -547,6 +579,13 @@ References custom_modes,
 

 Sets or unsets the parameters for a custom mode in a channels info. 
 

+
Parameters:

+  
+    
+    
+    
+  
mode The mode character to set or unset 
parameter The parameter string to associate with this mode character 
mode_on True if you want to set the mode or false if you want to remove it

+

 
 

 Definition at line 144 of file channels.cpp.
@@ -896,7 +935,7 @@ Referenced by chanrec()
 
The documentation for this class was generated from the following files:
-
Generated on Wed May 25 21:42:57 2005 for InspIRCd by
+
Generated on Wed May 25 22:02:48 2005 for InspIRCd by
 
 doxygen 
 1.3.3 

-- 
cgit v1.2.3