Update documentation for timeout methods

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@11090 72102866-910b-0410-8b05-ffd578937521

ChangeLog

@@ -6,6 +6,7 @@
 	than doubling each time.
 	* Headers/Foundation/NSConnection.h: Remove default timeout constant.
 	* configure.in: Check for float.h, not for values.h
+	* Documentation/gsdoc/NSConnection.gsdoc: updated.
 
 2001-10-05  Richard Frith-Macdonald <rfm@gnu.org>
 

Documentation/gsdoc/NSConnection.gsdoc

@@ -357,7 +357,10 @@
           <sel>replyTimeout</sel>
           <desc>
 	    Returns the timeout interval used when waiting for a reply to
-	    a request sent on the NSConnection.
+	    a request sent on the NSConnection.  This value is inherited
+	    from the parent connection or may be set using the
+	    setReplyTimeout: method.  The default value is the maximum
+	    delay (effectively infinite).
           </desc>
         </method>
         <method type="NSArray*">
@@ -371,7 +374,10 @@
           <sel>requestTimeout</sel>
           <desc>
 	    Returns the timeout interval used when waiting for a send
-	    operation to complete.
+	    operation to complete.  This value is inherited
+	    from the parent connection or may be set using the
+	    setRequestTimeout: method.  The default value is the maximum
+	    delay (effectively infinite).
           </desc>
         </method>
         <method type="id">
@@ -441,7 +447,7 @@
           <sel>setRequestTimeout:</sel>
           <arg type="NSTimeInterval">seconds</arg>
           <desc>
-	    Sets the time interval that the NSConnection will to send
+	    Sets the time interval that the NSConnection will wait to send
 	    one of its requests before raising an NSPortTimeoutException.
           </desc>
         </method>

Documentation/gsdoc/NSConnection.html

@@ -399,7 +399,10 @@ Standards:  GNUstep MacOS-X NotOpenStep<br>
 - (NSTimeInterval) <b>replyTimeout</b>;<br>
 
 	    Returns the timeout interval used when waiting for a reply to
-	    a request sent on the NSConnection.
+	    a request sent on the NSConnection.  This value is inherited
+	    from the parent connection or may be set using the
+	    setReplyTimeout: method.  The default value is the maximum
+	    delay (effectively infinite).
           
  <hr>
 <h3><a name ="method-24">requestModes</a></h3>
@@ -413,7 +416,10 @@ Standards:  GNUstep MacOS-X NotOpenStep<br>
 - (NSTimeInterval) <b>requestTimeout</b>;<br>
 
 	    Returns the timeout interval used when waiting for a send
-	    operation to complete.
+	    operation to complete.  This value is inherited
+	    from the parent connection or may be set using the
+	    setRequestTimeout: method.  The default value is the maximum
+	    delay (effectively infinite).
           
  <hr>
 <h3><a name ="method-26">rootObject</a></h3>
@@ -479,7 +485,7 @@ Standards:  GNUstep MacOS-X NotOpenStep<br>
 <h3><a name ="method-33">setRequestTimeout:</a></h3>
 - (void) <b>setRequestTimeout:</b> (NSTimeInterval)seconds;<br>
 
-	    Sets the time interval that the NSConnection will to send
+	    Sets the time interval that the NSConnection will wait to send
 	    one of its requests before raising an NSPortTimeoutException.
           
  <hr>