summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorminfrin <minfrin@13f79535-47bb-0310-9956-ffa450edef68>2010-01-06 11:45:27 +0000
committerminfrin <minfrin@13f79535-47bb-0310-9956-ffa450edef68>2010-01-06 11:45:27 +0000
commit0b78b1518f17df182a18970326e4225d61303869 (patch)
treea86bb1e351300c0e8eee4d472df03d7c8ff9a0e7
parentd29160371800b89fabce5270de40a6029218dd7e (diff)
downloadlibapr-0b78b1518f17df182a18970326e4225d61303869.tar.gz
Fixes various doxygen usage warnings and minor doxygen errors.
Submitted by: Neil Conway <nrc@cs.berkeley.edu> git-svn-id: http://svn.apache.org/repos/asf/apr/apr/branches/1.3.x@896406 13f79535-47bb-0310-9956-ffa450edef68
-rw-r--r--include/apr_file_io.h3
-rw-r--r--include/apr_network_io.h7
-rw-r--r--include/apr_thread_proc.h4
-rw-r--r--include/apr_want.h6
4 files changed, 11 insertions, 9 deletions
diff --git a/include/apr_file_io.h b/include/apr_file_io.h
index bf173da7a..f799bac71 100644
--- a/include/apr_file_io.h
+++ b/include/apr_file_io.h
@@ -653,6 +653,7 @@ APR_DECLARE(apr_status_t) apr_file_pipe_create(apr_file_t **in,
* @param in The newly created pipe's file for reading.
* @param out The newly created pipe's file for writing.
* @param blocking one of these values defined in apr_thread_proc.h;
+ * @param pool The pool to operate on.
* <pre>
* APR_FULL_BLOCK
* APR_READ_BLOCK
@@ -671,7 +672,7 @@ APR_DECLARE(apr_status_t) apr_file_pipe_create(apr_file_t **in,
APR_DECLARE(apr_status_t) apr_file_pipe_create_ex(apr_file_t **in,
apr_file_t **out,
apr_int32_t blocking,
- apr_pool_t *p);
+ apr_pool_t *pool);
/**
* Create a named pipe.
diff --git a/include/apr_network_io.h b/include/apr_network_io.h
index 4e3789d2b..89f57c039 100644
--- a/include/apr_network_io.h
+++ b/include/apr_network_io.h
@@ -509,9 +509,10 @@ APR_DECLARE(apr_status_t) apr_socket_sendto(apr_socket_t *sock,
/**
* Read data from a socket. On success, the address of the peer from
- * which the data was sent is copied into the @param from parameter,
- * and the @param len parameter is updated to give the number of bytes
- * written to @param buf.
+ * which the data was sent is copied into the @a from parameter, and the
+ * @a len parameter is updated to give the number of bytes written to
+ * @a buf.
+ *
* @param from Updated with the address from which the data was received
* @param sock The socket to use
* @param flags The flags to use
diff --git a/include/apr_thread_proc.h b/include/apr_thread_proc.h
index 4bcc4eeb8..7df84ef32 100644
--- a/include/apr_thread_proc.h
+++ b/include/apr_thread_proc.h
@@ -730,13 +730,13 @@ APR_DECLARE(void) apr_proc_other_child_unregister(void *data);
* <pre>
* rv = apr_proc_wait_all_procs(&proc, &exitcode, &status, APR_WAIT, p);
* if (APR_STATUS_IS_CHILD_DONE(rv)) {
- * #if APR_HAS_OTHER_CHILD
+ * \#if APR_HAS_OTHER_CHILD
* if (apr_proc_other_child_alert(&proc, APR_OC_REASON_DEATH, status)
* == APR_SUCCESS) {
* ; (already handled)
* }
* else
- * #endif
+ * \#endif
* [... handling non-otherchild processes death ...]
* </pre>
*/
diff --git a/include/apr_want.h b/include/apr_want.h
index 1afed3606..14fa9d0b4 100644
--- a/include/apr_want.h
+++ b/include/apr_want.h
@@ -30,9 +30,9 @@
*
* Typical usage:
*
- * #define APR_WANT_STRFUNC
- * #define APR_WANT_MEMFUNC
- * #include "apr_want.h"
+ * \#define APR_WANT_STRFUNC
+ * \#define APR_WANT_MEMFUNC
+ * \#include "apr_want.h"
*
* The appropriate headers will be included.
*