Changed documentation to add parameters

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1523 e03df62e-2008-0410-955e-edbf42e46eb7

5 files changed, 256 insertions, 61 deletions

diff --git a/docs/man/man3/channels.h.3 b/docs/man/man3/channels.h.3
index 34f89005e..8ef439af1 100644
--- a/docs/man/man3/channels.h.3
+++ b/docs/man/man3/channels.h.3
@@ -124,19 +124,19 @@ Definition at line 30 of file channels.h.
 Definition at line 26 of file channels.h.
 .SS "#define UCMODE_FOUNDER   16"
 .PP
-Definition at line 215 of file channels.h.
+Definition at line 234 of file channels.h.
 .SS "#define UCMODE_HOP   4"
 .PP
-Definition at line 213 of file channels.h.
+Definition at line 232 of file channels.h.
 .SS "#define UCMODE_OP   1"
 .PP
-Definition at line 211 of file channels.h.
+Definition at line 230 of file channels.h.
 .SS "#define UCMODE_PROTECT   8"
 .PP
-Definition at line 214 of file channels.h.
+Definition at line 233 of file channels.h.
 .SS "#define UCMODE_VOICE   2"
 .PP
-Definition at line 212 of file channels.h.
+Definition at line 231 of file channels.h.
 .SH "Typedef Documentation"
 .PP 
 .SS "typedef std::vector<\fBBanItem\fP> \fBBanList\fP"
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
diff --git a/docs/man/man3/connection.3 b/docs/man/man3/connection.3
index 00f6667fe..ce6ea9e37 100644
--- a/docs/man/man3/connection.3
+++ b/docs/man/man3/connection.3
@@ -84,7 +84,7 @@ Inherited by \fBserverrec\fP, and \fBuserrec\fP.
 .in -1c
 .SH "Detailed Description"
 .PP 
-Please note: classes serverrec and userrec both inherit from class connection. Definition at line 261 of file connection.h.
+Please note: classes serverrec and userrec both inherit from class connection. Definition at line 296 of file connection.h.
 .SH "Constructor & Destructor Documentation"
 .PP 
 .SS "connection::connection ()"
@@ -94,72 +94,72 @@ Default constructor.
 .PP 
 .SS "int \fBconnection::bytes_in\fP"
 .PP
-Stats counter for bytes inbound. Definition at line 278 of file connection.h.
+Stats counter for bytes inbound. Definition at line 313 of file connection.h.
 .PP
 Referenced by userrec::userrec().
 .SS "int \fBconnection::bytes_out\fP"
 .PP
-Stats counter for bytes outbound. Definition at line 282 of file connection.h.
+Stats counter for bytes outbound. Definition at line 317 of file connection.h.
 .PP
 Referenced by userrec::FlushWriteBuf(), and userrec::userrec().
 .SS "int \fBconnection::cmds_in\fP"
 .PP
-Stats counter for commands inbound. Definition at line 286 of file connection.h.
+Stats counter for commands inbound. Definition at line 321 of file connection.h.
 .PP
 Referenced by userrec::userrec().
 .SS "int \fBconnection::cmds_out\fP"
 .PP
-Stats counter for commands outbound. Definition at line 290 of file connection.h.
+Stats counter for commands outbound. Definition at line 325 of file connection.h.
 .PP
 Referenced by userrec::FlushWriteBuf(), and userrec::userrec().
 .SS "int \fBconnection::fd\fP"
 .PP
-File descriptor of the connection. Definition at line 266 of file connection.h.
+File descriptor of the connection. Definition at line 301 of file connection.h.
 .PP
 Referenced by serverrec::BeginLink(), serverrec::CreateListener(), ConfigReader::DumpErrors(), serverrec::MeshCookie(), Server::PseudoToUser(), userrec::ReadData(), Server::SendTo(), serverrec::serverrec(), userrec::userrec(), and Server::UserToPseudo().
 .SS "bool \fBconnection::haspassed\fP"
 .PP
-True if server/user has authenticated, false if otherwise. Definition at line 294 of file connection.h.
+True if server/user has authenticated, false if otherwise. Definition at line 329 of file connection.h.
 .PP
 Referenced by userrec::userrec().
 .SS "char \fBconnection::host\fP[160]"
 .PP
-Hostname of connection. Not used if this is a serverrecDefinition at line 270 of file connection.h.
+Hostname of connection. Not used if this is a serverrecDefinition at line 305 of file connection.h.
 .PP
 Referenced by userrec::GetFullRealHost(), Server::PseudoToUser(), userrec::userrec(), and Server::UserToPseudo().
 .SS "time_t \fBconnection::idle_lastmsg\fP"
 .PP
-Time that the connection last sent data, used to calculate idle time. Definition at line 316 of file connection.h.
+Time that the connection last sent data, used to calculate idle time. Definition at line 351 of file connection.h.
 .PP
 Referenced by userrec::userrec().
 .SS "char \fBconnection::ip\fP[16]"
 .PP
-IP of connection. Definition at line 274 of file connection.h.
+IP of connection. Definition at line 309 of file connection.h.
 .PP
 Referenced by userrec::userrec().
 .SS "time_t \fBconnection::lastping\fP"
 .PP
-Time the connection was last pinged. Definition at line 308 of file connection.h.
+Time the connection was last pinged. Definition at line 343 of file connection.h.
 .PP
 Referenced by serverrec::serverrec(), and userrec::userrec().
 .SS "time_t \fBconnection::nping\fP"
 .PP
-Used by PING checks with clients. Definition at line 320 of file connection.h.
+Used by PING checks with clients. Definition at line 355 of file connection.h.
 .PP
 Referenced by userrec::userrec().
 .SS "int \fBconnection::port\fP"
 .PP
-Port number For a userrec, this is the port they connected to the network on. For a serverrec this is the current listening port of the serverrec object.Definition at line 300 of file connection.h.
+Port number For a userrec, this is the port they connected to the network on. For a serverrec this is the current listening port of the serverrec object.Definition at line 335 of file connection.h.
 .PP
 Referenced by serverrec::CreateListener(), and userrec::userrec().
 .SS "char \fBconnection::registered\fP"
 .PP
-Used by userrec to indicate the registration status of the connection. Definition at line 304 of file connection.h.
+Used by userrec to indicate the registration status of the connection. Definition at line 339 of file connection.h.
 .PP
 Referenced by userrec::userrec().
 .SS "time_t \fBconnection::signon\fP"
 .PP
-Time the connection was created, set in the constructor. Definition at line 312 of file connection.h.
+Time the connection was created, set in the constructor. Definition at line 347 of file connection.h.
 .PP
 Referenced by serverrec::serverrec(), and userrec::userrec().
 
diff --git a/docs/man/man3/ircd_connector.3 b/docs/man/man3/ircd_connector.3
index a4a0b6011..6bd266f7b 100644
--- a/docs/man/man3/ircd_connector.3
+++ b/docs/man/man3/ircd_connector.3
@@ -78,7 +78,7 @@ Inherits \fBExtensible\fP.
 .ti -1c
 .RI "bool \fBAddBuffer\fP (std::string a)"
 .br
-.RI "\fIThis method adds text to the ircd connection's buffer This buffer's maximum size is one megabyte, the method returning false if the buffer is full. \fP"
+.RI "\fIThis method adds text to the ircd connection's buffer. \fP"
 .ti -1c
 .RI "bool \fBBufferIsComplete\fP ()"
 .br
@@ -102,7 +102,7 @@ Inherits \fBExtensible\fP.
 .ti -1c
 .RI "bool \fBAddWriteBuf\fP (std::string data)"
 .br
-.RI "\fIAdds data to the connection's sendQ to be flushed later Fails if there is an error pending on the connection. \fP"
+.RI "\fIAdds data to the connection's sendQ to be flushed later. \fP"
 .ti -1c
 .RI "bool \fBFlushWriteBuf\fP ()"
 .br
@@ -218,16 +218,52 @@ Constructor clears the sendq and initialises the fd to -1.
 .PP 
 .SS "bool ircd_connector::AddBuffer (std::string a)"
 .PP
-This method adds text to the ircd connection's buffer This buffer's maximum size is one megabyte, the method returning false if the buffer is full. 
+This method adds text to the ircd connection's buffer. \fBParameters:\fP
+.RS 4
+\fIa\fP The text to add to the buffer up to a maximum size of 1MB
+.RE
+.PP
+This buffer's maximum size is one megabyte, the method returning false if the buffer is full.
+.PP
+\fBReturns:\fP
+.RS 4
+True on success, false if the buffer is full or the connection is down
+.RE
+.PP
+
 .SS "bool ircd_connector::AddWriteBuf (std::string data)"
 .PP
-Adds data to the connection's sendQ to be flushed later Fails if there is an error pending on the connection. Referenced by serverrec::SendPacket().
+Adds data to the connection's sendQ to be flushed later. \fBParameters:\fP
+.RS 4
+\fIdata\fP The data to add to the write buffer
+.RE
+.PP
+Fails if there is an error pending on the connection.
+.PP
+\fBReturns:\fP
+.RS 4
+True on success, false if the connection is down or the buffer is full
+.RE
+.PP
+Referenced by serverrec::SendPacket().
 .SS "bool ircd_connector::BufferIsComplete ()"
 .PP
 This method returns true if the buffer contains at least one carriage return character, e.g. one line can be read from the buffer successfully.
+.PP
+\fBReturns:\fP
+.RS 4
+True if there is at least one complete line waiting to be processed
+.RE
+.PP
+
 .SS "bool ircd_connector::CheckPing ()"
 .PP
-Checks if the connection replied to its last ping, and if it did sends another and returns true, if not, returns false. 
+Checks if the connection replied to its last ping, and if it did sends another and returns true, if not, returns false. \fBReturns:\fP
+.RS 4
+True if the server is still replying to pings
+.RE
+.PP
+
 .SS "void ircd_connector::ClearBuffer ()"
 .PP
 This method clears the server's buffer by setting it to an empty string. 
@@ -236,37 +272,89 @@ This method clears the server's buffer by setting it to an empty string.
 Close the connection by calling close() on its file descriptor This function call updates no other data. Referenced by serverrec::SendPacket().
 .SS "bool ircd_connector::FlushWriteBuf ()"
 .PP
-Flushes as much of the data from the buffer as possible, and advances the queue pointer to what is left. Referenced by serverrec::SendPacket().
+Flushes as much of the data from the buffer as possible, and advances the queue pointer to what is left. \fBReturns:\fP
+.RS 4
+True if the flush succeeded, false if the connection is down
+.RE
+.PP
+Referenced by serverrec::SendPacket().
 .SS "std::string ircd_connector::GetBuffer ()"
 .PP
-This method retrieves the first string from the tail end of the buffer and advances the tail end of the buffer past the returned string, in a similar manner to strtok(). 
+This method retrieves the first string from the tail end of the buffer and advances the tail end of the buffer past the returned string, in a similar manner to strtok(). \fBReturns:\fP
+.RS 4
+The first line of the buffer up to a carriage return
+.RE
+.PP
+
 .SS "std::string ircd_connector::GetDescription ()"
 .PP
-Get the server description of this connection. 
+Get the server description of this connection. \fBReturns:\fP
+.RS 4
+The description (GECOS) of this connection
+.RE
+.PP
+
 .SS "int ircd_connector::GetDescriptor ()"
 .PP
-Get the file descriptor associated with this connection. 
+Get the file descriptor associated with this connection. \fBReturns:\fP
+.RS 4
+The file descriptor associated with this connection
+.RE
+.PP
+
 .SS "char* ircd_connector::GetServerIP ()"
 .PP
-Get the ip address (not servername) associated with this connection. 
+Get the ip address (not servername) associated with this connection. \fBReturns:\fP
+.RS 4
+The connections IP address in dotted decimal form
+.RE
+.PP
+
 .SS "std::string ircd_connector::GetServerName ()"
 .PP
 Return the servername on this established connection. Referenced by serverrec::SendPacket().
 .SS "int ircd_connector::GetServerPort ()"
 .PP
-Get the port number being used for this connection If the connection is outbound this will be the remote port otherwise it will be the local port, so it can always be gautanteed as open at the address given in \fBGetServerIP()\fP. 
+Get the port number being used for this connection If the connection is outbound this will be the remote port otherwise it will be the local port, so it can always be gautanteed as open at the address given in \fBGetServerIP()\fP. \fBReturns:\fP
+.RS 4
+The port number of this connection
+.RE
+.PP
+
 .SS "int ircd_connector::GetState ()"
 .PP
-Get the state flags for this connection. Referenced by IsRoutable(), and serverrec::SendPacket().
+Get the state flags for this connection. \fBReturns:\fP
+.RS 4
+The state flags associated with this connection
+.RE
+.PP
+Referenced by IsRoutable(), and serverrec::SendPacket().
 .SS "std::string ircd_connector::GetVersionString ()"
 .PP
 This method returns the version string of the remote server. If the server has no version string an empty string is returned.
+.PP
+\fBReturns:\fP
+.RS 4
+The version text of this connection
+.RE
+.PP
+
 .SS "std::string ircd_connector::GetWriteError ()"
 .PP
-Gets the error string for this connection. Referenced by serverrec::SendPacket().
+Gets the error string for this connection. \fBReturns:\fP
+.RS 4
+The last error to occur or an empty string
+.RE
+.PP
+Referenced by serverrec::SendPacket().
 .SS "bool ircd_connector::HasBufferedOutput ()"
 .PP
-Returns true if there is data to be written that hasn't been sent yet. 
+Returns true if there is data to be written that hasn't been sent yet. \fBReturns:\fP
+.RS 4
+True if the buffer is not empty
+.RE
+.PP
+
 .SS "bool ircd_connector::MakeOutboundConnection (char * newhost, int newport)"
 .PP
 Create an outbound connection to a listening socket. Referenced by serverrec::BeginLink(), and serverrec::MeshCookie().
@@ -275,31 +363,78 @@ Create an outbound connection to a listening socket. Referenced by serverrec::Be
 Resets the ping counter. 
 .SS "void ircd_connector::SetDescription (std::string desc)"
 .PP
-Set the server description of this connection. 
+Set the server description of this connection. \fBParameters:\fP
+.RS 4
+\fIdesc\fP The description (GECOS) of this connection to be set
+.RE
+.PP
+
 .SS "void ircd_connector::SetDescriptor (int fd)"
 .PP
-Set the file descriptor for this connection. Referenced by serverrec::AddIncoming().
+Set the file descriptor for this connection. \fBParameters:\fP
+.RS 4
+\fIfd\fP The file descriptor to associate with the connection
+.RE
+.PP
+Referenced by serverrec::AddIncoming().
 .SS "bool ircd_connector::SetHostAddress (char * host, int port)\fC [private]\fP"
 .PP
 PRIVATE function to set the host address and port to connect to. 
 .SS "bool ircd_connector::SetHostAndPort (char * newhost, int newport)"
 .PP
-Set both the host and the port in one operation for this connection. Referenced by serverrec::AddIncoming(), serverrec::BeginLink(), and serverrec::MeshCookie().
+Set both the host and the port in one operation for this connection. \fBParameters:\fP
+.RS 4
+\fInewhost\fP The hostname to set for this connection 
+.br
+\fInewport\fP The port number to set for this connection 
+.RE
+.PP
+\fBReturns:\fP
+.RS 4
+True on success, false on failure
+.RE
+.PP
+Referenced by serverrec::AddIncoming(), serverrec::BeginLink(), and serverrec::MeshCookie().
 .SS "void ircd_connector::SetServerName (std::string serv)"
 .PP
-Set the server name of this connection. Referenced by serverrec::AddIncoming(), serverrec::BeginLink(), and serverrec::MeshCookie().
+Set the server name of this connection. \fBParameters:\fP
+.RS 4
+\fIserv\fP The server name to set
+.RE
+.PP
+Referenced by serverrec::AddIncoming(), serverrec::BeginLink(), and serverrec::MeshCookie().
 .SS "void ircd_connector::SetServerPort (int p)"
 .PP
-Set the port used by this connection. 
+Set the port used by this connection. \fBParameters:\fP
+.RS 4
+\fIp\fP The port number to set for this connection
+.RE
+.PP
+
 .SS "void ircd_connector::SetState (int state)"
 .PP
-Set the state flags for this connection. Referenced by serverrec::AddIncoming(), serverrec::BeginLink(), serverrec::MeshCookie(), and serverrec::SendPacket().
+Set the state flags for this connection. \fBParameters:\fP
+.RS 4
+\fIstate\fP The state flags to set for this connection
+.RE
+.PP
+Referenced by serverrec::AddIncoming(), serverrec::BeginLink(), serverrec::MeshCookie(), and serverrec::SendPacket().
 .SS "void ircd_connector::SetVersionString (std::string newversion)"
 .PP
-This method sets the version string of the remote server. 
+This method sets the version string of the remote server. \fBParameters:\fP
+.RS 4
+\fInewversion\fP The version string to set
+.RE
+.PP
+
 .SS "void ircd_connector::SetWriteError (std::string error)"
 .PP
-Sets the error string for this connection. 
+Sets the error string for this connection. \fBParameters:\fP
+.RS 4
+\fIerror\fP The error string to set
+.RE
+.PP
+
 .SH "Member Data Documentation"
 .PP 
 .SS "sockaddr_in \fBircd_connector::addr\fP\fC [private]\fP"
diff --git a/docs/man/man3/ucrec.3 b/docs/man/man3/ucrec.3
index e39d6505b..93895a59f 100644
--- a/docs/man/man3/ucrec.3
+++ b/docs/man/man3/ucrec.3
@@ -40,33 +40,33 @@ Holds a user's modes on a channel This class associates a users privilages with
 
 The uc_modes member holds a bitmask of which privilages the user has on the channel, such as op, voice, etc. 
 .PP
-Definition at line 222 of file channels.h.
+Definition at line 241 of file channels.h.
 .SH "Constructor & Destructor Documentation"
 .PP 
 .SS "ucrec::ucrec ()\fC [inline]\fP"
 .PP
-Definition at line 235 of file channels.h.
+Definition at line 254 of file channels.h.
 .PP
 .nf
-235 { /* stub */ }
+254 { /* stub */ }
 .fi
 .SS "virtual ucrec::~\fBucrec\fP ()\fC [inline, virtual]\fP"
 .PP
-Definition at line 236 of file channels.h.
+Definition at line 255 of file channels.h.
 .PP
 .nf
-236 { /* stub */ }
+255 { /* stub */ }
 .fi
 .SH "Member Data Documentation"
 .PP 
 .SS "\fBchanrec\fP* \fBucrec::channel\fP"
 .PP
-Points to the channel record where the given modes apply. If the record is not in use, this value will be NULL.Definition at line 233 of file channels.h.
+Points to the channel record where the given modes apply. If the record is not in use, this value will be NULL.Definition at line 252 of file channels.h.
 .PP
 Referenced by Server::PseudoToUser(), and userrec::userrec().
 .SS "char \fBucrec::uc_modes\fP"
 .PP
-Contains a bitmask of the UCMODE_OP ... UCMODE_FOUNDER values. If this value is zero, the user has no privilages upon the channel.Definition at line 228 of file channels.h.
+Contains a bitmask of the UCMODE_OP ... UCMODE_FOUNDER values. If this value is zero, the user has no privilages upon the channel.Definition at line 247 of file channels.h.
 .PP
 Referenced by userrec::userrec().