svn commit: r109329 - /apr/apr/trunk/include/apr_lib.h /apr/apr/trunk/include/apr_network_io.h

[jo...@apache.org]

Author: jorton
Date: Wed Dec  1 03:58:27 2004
New Revision: 109329

URL: http://svn.apache.org/viewcvs?view=rev&rev=109329
Log:
* include/apr_network_io.h (apr_socket_sendfile): Document
that the offset parameter is pass-by-reference for no reason.

* include/apr_lib.h (apr_password_get): Likewise for the bufsize
parameter.

Modified:
   apr/apr/trunk/include/apr_lib.h
   apr/apr/trunk/include/apr_network_io.h

Modified: apr/apr/trunk/include/apr_lib.h
Url: http://svn.apache.org/viewcvs/apr/apr/trunk/include/apr_lib.h?view=diff&rev=109329&p1=apr/apr/trunk/include/apr_lib.h&r1=109328&p2=apr/apr/trunk/include/apr_lib.h&r2=109329
==============================================================================
--- apr/apr/trunk/include/apr_lib.h	(original)
+++ apr/apr/trunk/include/apr_lib.h	Wed Dec  1 03:58:27 2004
@@ -170,6 +170,9 @@
  * @param bufsize The length of the password buffer.
  * @remark If the password entered must be truncated to fit in
  * the provided buffer, APR_ENAMETOOLONG will be returned.
+ * Note that the bufsize paramater is passed by reference for no
+ * reason; its value will never be modified by the apr_password_get()
+ * function.
  */
 APR_DECLARE(apr_status_t) apr_password_get(const char *prompt, char *pwbuf, 
                                            apr_size_t *bufsize);

Modified: apr/apr/trunk/include/apr_network_io.h
Url: http://svn.apache.org/viewcvs/apr/apr/trunk/include/apr_network_io.h?view=diff&rev=109329&p1=apr/apr/trunk/include/apr_network_io.h&r1=109328&p2=apr/apr/trunk/include/apr_network_io.h&r2=109329
==============================================================================
--- apr/apr/trunk/include/apr_network_io.h	(original)
+++ apr/apr/trunk/include/apr_network_io.h	Wed Dec  1 03:58:27 2004
@@ -530,7 +530,9 @@
  * @remark This functions acts like a blocking write by default.  To change 
  *         this behavior, use apr_socket_timeout_set() or the
  *         APR_SO_NONBLOCK socket option.
- *         The number of bytes actually sent is stored in argument 5.
+ * The number of bytes actually sent is stored in the len parameter.
+ * The offset parameter is passed by reference for no reason; its
+ * value will never be modified by the apr_socket_sendfile() function.
  */
 APR_DECLARE(apr_status_t) apr_socket_sendfile(apr_socket_t *sock, 
                                               apr_file_t *file,