summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorjorton <jorton@13f79535-47bb-0310-9956-ffa450edef68>2004-12-01 11:58:27 +0000
committerjorton <jorton@13f79535-47bb-0310-9956-ffa450edef68>2004-12-01 11:58:27 +0000
commitccdf223cfef07a7bfbbb2ca7490dbc5b499e9ff1 (patch)
tree14d5ef03889a9e8071792b8298747bb8b0258473 /include
parent5f4867b1b8c67d52052346dd5a50099d437ed41b (diff)
downloadlibapr-ccdf223cfef07a7bfbbb2ca7490dbc5b499e9ff1.tar.gz
* 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. git-svn-id: http://svn.apache.org/repos/asf/apr/apr/trunk@109329 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'include')
-rw-r--r--include/apr_lib.h3
-rw-r--r--include/apr_network_io.h4
2 files changed, 6 insertions, 1 deletions
diff --git a/include/apr_lib.h b/include/apr_lib.h
index bf34457e2..cb1dcedf5 100644
--- a/include/apr_lib.h
+++ b/include/apr_lib.h
@@ -170,6 +170,9 @@ APR_DECLARE(int) apr_vformatter(int (*flush_func)(apr_vformatter_buff_t *b),
* @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);
diff --git a/include/apr_network_io.h b/include/apr_network_io.h
index 0157a46b6..3e1475229 100644
--- a/include/apr_network_io.h
+++ b/include/apr_network_io.h
@@ -530,7 +530,9 @@ APR_DECLARE(apr_status_t) apr_socket_recvfrom(apr_sockaddr_t *from,
* @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,