Changed documentation to add parameters

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

1 files changed, 77 insertions, 7 deletions

diff --git a/docs/module-doc/classircd__connector.html b/docs/module-doc/classircd__connector.html
index e57bf5159..047c68bdd 100644
--- a/docs/module-doc/classircd__connector.html
+++ b/docs/module-doc/classircd__connector.html
@@ -69,7 +69,7 @@ Inheritance diagram for ircd_connector:<p><center><img src="classircd__connector
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Close the connection by calling close() on its file descriptor This function call updates no other data. </em> <a href="#a14"></a><em><br><br></td></tr>
 <tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#a15">AddBuffer</a> (std::string a)</td></tr>
 
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">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. </em> <a href="#a15"></a><em><br><br></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method adds text to the ircd connection's buffer. </em> <a href="#a15"></a><em><br><br></td></tr>
 <tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#a16">BufferIsComplete</a> ()</td></tr>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns true if the buffer contains at least one carriage return character, e.g. </em> <a href="#a16"></a><em><br><br></td></tr>
@@ -87,7 +87,7 @@ Inheritance diagram for ircd_connector:<p><center><img src="classircd__connector
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns the version string of the remote server. </em> <a href="#a20"></a><em><br><br></td></tr>
 <tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#a21">AddWriteBuf</a> (std::string data)</td></tr>
 
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds data to the connection's sendQ to be flushed later Fails if there is an error pending on the connection. </em> <a href="#a21"></a><em><br><br></td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds data to the connection's sendQ to be flushed later. </em> <a href="#a21"></a><em><br><br></td></tr>
 <tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#a22">FlushWriteBuf</a> ()</td></tr>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Flushes as much of the data from the buffer as possible, and advances the queue pointer to what is left. </em> <a href="#a22"></a><em><br><br></td></tr>
@@ -221,8 +221,15 @@ Constructor clears the sendq and initialises the fd to -1.
     <td>
 
 <p>
-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. 
 <p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign=top><em>a</em>&nbsp;</td><td>The text to add to the buffer up to a maximum size of 1MB</td></tr>
+  </table>
+</dl>
+This buffer's maximum size is one megabyte, the method returning false if the buffer is full.<p>
+<dl compact><dt><b>Returns:</b></dt><dd>True on success, false if the buffer is full or the connection is down</dd></dl>
     </td>
   </tr>
 </table>
@@ -252,8 +259,15 @@ This method adds text to the ircd connection's buffer This buffer's maximum size
     <td>
 
 <p>
-Adds data to the connection's sendQ to be flushed later Fails if there is an error pending on the connection. 
+Adds data to the connection's sendQ to be flushed later. 
 <p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign=top><em>data</em>&nbsp;</td><td>The data to add to the write buffer</td></tr>
+  </table>
+</dl>
+Fails if there is an error pending on the connection.<p>
+<dl compact><dt><b>Returns:</b></dt><dd>True on success, false if the connection is down or the buffer is full</dd></dl>
 
 <p>
 Referenced by <a class="el" href="servers_8cpp-source.html#l00336">serverrec::SendPacket()</a>.    </td>
@@ -286,7 +300,9 @@ Referenced by <a class="el" href="servers_8cpp-source.html#l00336">serverrec::Se
 <p>
 This method returns true if the buffer contains at least one carriage return character, e.g. 
 <p>
-one line can be read from the buffer successfully.    </td>
+one line can be read from the buffer successfully.<p>
+<dl compact><dt><b>Returns:</b></dt><dd>True if there is at least one complete line waiting to be processed</dd></dl>
+    </td>
   </tr>
 </table>
 <a name="a26" doxytag="ircd_connector::CheckPing"></a><p>
@@ -316,6 +332,7 @@ one line can be read from the buffer successfully.    </td>
 <p>
 Checks if the connection replied to its last ping, and if it did sends another and returns true, if not, returns false. 
 <p>
+<dl compact><dt><b>Returns:</b></dt><dd>True if the server is still replying to pings</dd></dl>
     </td>
   </tr>
 </table>
@@ -408,6 +425,7 @@ Referenced by <a class="el" href="servers_8cpp-source.html#l00336">serverrec::Se
 <p>
 Flushes as much of the data from the buffer as possible, and advances the queue pointer to what is left. 
 <p>
+<dl compact><dt><b>Returns:</b></dt><dd>True if the flush succeeded, false if the connection is down</dd></dl>
 
 <p>
 Referenced by <a class="el" href="servers_8cpp-source.html#l00336">serverrec::SendPacket()</a>.    </td>
@@ -440,6 +458,7 @@ Referenced by <a class="el" href="servers_8cpp-source.html#l00336">serverrec::Se
 <p>
 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(). 
 <p>
+<dl compact><dt><b>Returns:</b></dt><dd>The first line of the buffer up to a carriage return</dd></dl>
     </td>
   </tr>
 </table>
@@ -470,6 +489,7 @@ This method retrieves the first string from the tail end of the buffer and advan
 <p>
 Get the server description of this connection. 
 <p>
+<dl compact><dt><b>Returns:</b></dt><dd>The description (GECOS) of this connection</dd></dl>
     </td>
   </tr>
 </table>
@@ -500,6 +520,7 @@ Get the server description of this connection.
 <p>
 Get the file descriptor associated with this connection. 
 <p>
+<dl compact><dt><b>Returns:</b></dt><dd>The file descriptor associated with this connection</dd></dl>
     </td>
   </tr>
 </table>
@@ -530,6 +551,7 @@ Get the file descriptor associated with this connection.
 <p>
 Get the ip address (not servername) associated with this connection. 
 <p>
+<dl compact><dt><b>Returns:</b></dt><dd>The connections IP address in dotted decimal form</dd></dl>
     </td>
   </tr>
 </table>
@@ -592,6 +614,7 @@ Referenced by <a class="el" href="servers_8cpp-source.html#l00336">serverrec::Se
 <p>
 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 <a class="el" href="classircd__connector.html#a8">GetServerIP()</a>. 
 <p>
+<dl compact><dt><b>Returns:</b></dt><dd>The port number of this connection</dd></dl>
     </td>
   </tr>
 </table>
@@ -622,6 +645,7 @@ Get the port number being used for this connection If the connection is outbound
 <p>
 Get the state flags for this connection. 
 <p>
+<dl compact><dt><b>Returns:</b></dt><dd>The state flags associated with this connection</dd></dl>
 
 <p>
 Referenced by <a class="el" href="servers_8cpp-source.html#l00256">IsRoutable()</a>, and <a class="el" href="servers_8cpp-source.html#l00336">serverrec::SendPacket()</a>.    </td>
@@ -654,7 +678,9 @@ Referenced by <a class="el" href="servers_8cpp-source.html#l00256">IsRoutable()<
 <p>
 This method returns the version string of the remote server. 
 <p>
-If the server has no version string an empty string is returned.    </td>
+If the server has no version string an empty string is returned.<p>
+<dl compact><dt><b>Returns:</b></dt><dd>The version text of this connection</dd></dl>
+    </td>
   </tr>
 </table>
 <a name="a24" doxytag="ircd_connector::GetWriteError"></a><p>
@@ -684,6 +710,7 @@ If the server has no version string an empty string is returned.    </td>
 <p>
 Gets the error string for this connection. 
 <p>
+<dl compact><dt><b>Returns:</b></dt><dd>The last error to occur or an empty string</dd></dl>
 
 <p>
 Referenced by <a class="el" href="servers_8cpp-source.html#l00336">serverrec::SendPacket()</a>.    </td>
@@ -716,6 +743,7 @@ Referenced by <a class="el" href="servers_8cpp-source.html#l00336">serverrec::Se
 <p>
 Returns true if there is data to be written that hasn't been sent yet. 
 <p>
+<dl compact><dt><b>Returns:</b></dt><dd>True if the buffer is not empty</dd></dl>
     </td>
   </tr>
 </table>
@@ -819,6 +847,11 @@ Resets the ping counter.
 <p>
 Set the server description of this connection. 
 <p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign=top><em>desc</em>&nbsp;</td><td>The description (GECOS) of this connection to be set</td></tr>
+  </table>
+</dl>
     </td>
   </tr>
 </table>
@@ -850,6 +883,11 @@ Set the server description of this connection.
 <p>
 Set the file descriptor for this connection. 
 <p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign=top><em>fd</em>&nbsp;</td><td>The file descriptor to associate with the connection</td></tr>
+  </table>
+</dl>
 
 <p>
 Referenced by <a class="el" href="servers_8cpp-source.html#l00212">serverrec::AddIncoming()</a>.    </td>
@@ -932,6 +970,13 @@ PRIVATE function to set the host address and port to connect to.
 <p>
 Set both the host and the port in one operation for this connection. 
 <p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign=top><em>newhost</em>&nbsp;</td><td>The hostname to set for this connection </td></tr>
+    <tr><td valign=top><em>newport</em>&nbsp;</td><td>The port number to set for this connection </td></tr>
+  </table>
+</dl>
+<dl compact><dt><b>Returns:</b></dt><dd>True on success, false on failure</dd></dl>
 
 <p>
 Referenced by <a class="el" href="servers_8cpp-source.html#l00212">serverrec::AddIncoming()</a>, <a class="el" href="servers_8cpp-source.html#l00142">serverrec::BeginLink()</a>, and <a class="el" href="servers_8cpp-source.html#l00182">serverrec::MeshCookie()</a>.    </td>
@@ -965,6 +1010,11 @@ Referenced by <a class="el" href="servers_8cpp-source.html#l00212">serverrec::Ad
 <p>
 Set the server name of this connection. 
 <p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign=top><em>serv</em>&nbsp;</td><td>The server name to set</td></tr>
+  </table>
+</dl>
 
 <p>
 Referenced by <a class="el" href="servers_8cpp-source.html#l00212">serverrec::AddIncoming()</a>, <a class="el" href="servers_8cpp-source.html#l00142">serverrec::BeginLink()</a>, and <a class="el" href="servers_8cpp-source.html#l00182">serverrec::MeshCookie()</a>.    </td>
@@ -998,6 +1048,11 @@ Referenced by <a class="el" href="servers_8cpp-source.html#l00212">serverrec::Ad
 <p>
 Set the port used by this connection. 
 <p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign=top><em>p</em>&nbsp;</td><td>The port number to set for this connection</td></tr>
+  </table>
+</dl>
     </td>
   </tr>
 </table>
@@ -1029,6 +1084,11 @@ Set the port used by this connection.
 <p>
 Set the state flags for this connection. 
 <p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign=top><em>state</em>&nbsp;</td><td>The state flags to set for this connection</td></tr>
+  </table>
+</dl>
 
 <p>
 Referenced by <a class="el" href="servers_8cpp-source.html#l00212">serverrec::AddIncoming()</a>, <a class="el" href="servers_8cpp-source.html#l00142">serverrec::BeginLink()</a>, <a class="el" href="servers_8cpp-source.html#l00182">serverrec::MeshCookie()</a>, and <a class="el" href="servers_8cpp-source.html#l00336">serverrec::SendPacket()</a>.    </td>
@@ -1062,6 +1122,11 @@ Referenced by <a class="el" href="servers_8cpp-source.html#l00212">serverrec::Ad
 <p>
 This method sets the version string of the remote server. 
 <p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign=top><em>newversion</em>&nbsp;</td><td>The version string to set</td></tr>
+  </table>
+</dl>
     </td>
   </tr>
 </table>
@@ -1093,6 +1158,11 @@ This method sets the version string of the remote server.
 <p>
 Sets the error string for this connection. 
 <p>
+<dl compact><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign=top><em>error</em>&nbsp;</td><td>The error string to set</td></tr>
+  </table>
+</dl>
     </td>
   </tr>
 </table>
@@ -1464,7 +1534,7 @@ Definition at line <a class="el" href="connection_8h-source.html#l00094">94</a>
 </table>
 <hr>The documentation for this class was generated from the following file:<ul>
 <li><a class="el" href="connection_8h-source.html">connection.h</a></ul>
-<hr size="1"><address style="align: right;"><small>Generated on Wed May 25 21:43:19 2005 for InspIRCd by
+<hr size="1"><address style="align: right;"><small>Generated on Wed May 25 22:03:11 2005 for InspIRCd by
 <a href="http://www.doxygen.org/index.html">
 <img src="doxygen.png" alt="doxygen" align="middle" border=0 > 
 </a>1.3.3 </small></address>