1 files changed, 72 insertions, 12 deletions
diff --git a/docs/man/man3/chanrec.3 b/docs/man/man3/chanrec.3
index 6042f7166..85a066e63 100644
--- a/docs/man/man3/chanrec.3
+++ b/docs/man/man3/chanrec.3
@@ -38,11 +38,11 @@ Inherits \fBExtensible\fP.
 .ti -1c
 .RI "void \fBAddUser\fP (char *castuser)"
 .br
-.RI "\fIAdd 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. \fP"
+.RI "\fIAdd a user pointer to the internal reference list. \fP"
 .ti -1c
 .RI "void \fBDelUser\fP (char *castuser)"
 .br
-.RI "\fIDelete 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. \fP"
+.RI "\fIDelete a user pointer to the internal reference list. \fP"
 .ti -1c
 .RI "std::vector< char * > * \fBGetUsers\fP ()"
 .br
@@ -132,16 +132,21 @@ References binarymodes, created, custom_modes, internal_userlist, key, limit, na
 .fi
 .SS "virtual chanrec::~\fBchanrec\fP ()\fC [inline, virtual]\fP"
 .PP
-Definition at line 205 of file channels.h.
+Definition at line 224 of file channels.h.
 .PP
 .nf
-205 { /* stub */ }
+224 { /* stub */ }
 .fi
 .SH "Member Function Documentation"
 .PP 
 .SS "void chanrec::AddUser (char * castuser)"
 .PP
-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 201 of file channels.cpp.
+Add a user pointer to the internal reference list. \fBParameters:\fP
+.RS 4
+\fIcastuser\fP This should be a pointer to a userrec, casted to char*
+.RE
+.PP
+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.
 .PP
 References DEBUG, and internal_userlist.
 .PP
@@ -153,7 +158,12 @@ References DEBUG, and internal_userlist.
 .fi
 .SS "void chanrec::DelUser (char * castuser)"
 .PP
-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 207 of file channels.cpp.
+Delete a user pointer to the internal reference list. \fBParameters:\fP
+.RS 4
+\fIcastuser\fP This should be a pointer to a userrec, casted to char*
+.RE
+.PP
+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.
 .PP
 References DEBUG, internal_userlist, and name.
 .PP
@@ -173,7 +183,19 @@ References DEBUG, internal_userlist, and name.
 .fi
 .SS "std::string chanrec::GetModeParameter (char mode)"
 .PP
-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 181 of file channels.cpp.
+Returns the parameter for a custom mode on a channel. \fBParameters:\fP
+.RS 4
+\fImode\fP The mode character you wish to query
+.RE
+.PP
+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.
+.PP
+\fBReturns:\fP
+.RS 4
+The parameter for this mode is returned, or an empty string
+.RE
+.PP
+Definition at line 181 of file channels.cpp.
 .PP
 References custom_mode_params.
 .PP
@@ -194,7 +216,12 @@ References custom_mode_params.
 .fi
 .SS "long chanrec::GetUserCounter ()"
 .PP
-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. Definition at line 196 of file channels.cpp.
+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. \fBReturns:\fP
+.RS 4
+The number of users on this channel
+.RE
+.PP
+Definition at line 196 of file channels.cpp.
 .PP
 References internal_userlist.
 .PP
@@ -205,7 +232,14 @@ References internal_userlist.
 .fi
 .SS "std::vector< char * > * chanrec::GetUsers ()"
 .PP
-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.Definition at line 221 of file channels.cpp.
+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.
+.PP
+\fBReturns:\fP
+.RS 4
+This function returns a vector of userrec pointers, each of which has been casted to char* to prevent circular references
+.RE
+.PP
+Definition at line 221 of file channels.cpp.
 .PP
 References internal_userlist.
 .PP
@@ -218,7 +252,17 @@ Referenced by Server::GetUsers().
 .fi
 .SS "bool chanrec::IsCustomModeSet (char mode)"
 .PP
-Returns true if a custom mode is set on a channel. Definition at line 175 of file channels.cpp.
+Returns true if a custom mode is set on a channel. \fBParameters:\fP
+.RS 4
+\fImode\fP The mode character you wish to query 
+.RE
+.PP
+\fBReturns:\fP
+.RS 4
+True if the custom mode is set, false if otherwise
+.RE
+.PP
+Definition at line 175 of file channels.cpp.
 .PP
 References DEBUG.
 .PP
@@ -230,7 +274,14 @@ References DEBUG.
 .fi
 .SS "void chanrec::SetCustomMode (char mode, bool mode_on)"
 .PP
-Sets or unsets a custom mode in the channels info. Definition at line 119 of file channels.cpp.
+Sets or unsets a custom mode in the channels info. \fBParameters:\fP
+.RS 4
+\fImode\fP The mode character to set or unset 
+.br
+\fImode_on\fP True if you want to set the mode or false if you want to remove it
+.RE
+.PP
+Definition at line 119 of file channels.cpp.
 .PP
 References custom_modes, DEBUG, and SetCustomModeParam().
 .PP
@@ -260,7 +311,16 @@ References custom_modes, DEBUG, and SetCustomModeParam().
 .fi
 .SS "void chanrec::SetCustomModeParam (char mode, char * parameter, bool mode_on)"
 .PP
-Sets or unsets the parameters for a custom mode in a channels info. Definition at line 144 of file channels.cpp.
+Sets or unsets the parameters for a custom mode in a channels info. \fBParameters:\fP
+.RS 4
+\fImode\fP The mode character to set or unset 
+.br
+\fIparameter\fP The parameter string to associate with this mode character 
+.br
+\fImode_on\fP True if you want to set the mode or false if you want to remove it
+.RE
+.PP
+Definition at line 144 of file channels.cpp.
 .PP
 References ModeParameter::channel, custom_mode_params, DEBUG, ModeParameter::mode, and ModeParameter::parameter.
 .PP