You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@apr.apache.org by mi...@apache.org on 2010/01/06 12:36:56 UTC

svn commit: r896402 - in /apr/apr/branches/1.4.x/include: apr_file_io.h apr_network_io.h apr_thread_proc.h apr_want.h

Author: minfrin
Date: Wed Jan  6 11:36:50 2010
New Revision: 896402

URL: http://svn.apache.org/viewvc?rev=896402&view=rev
Log:
Fixes various doxygen usage warnings and minor doxygen errors.
Submitted by: Neil Conway <nr...@cs.berkeley.edu>

Modified:
    apr/apr/branches/1.4.x/include/apr_file_io.h
    apr/apr/branches/1.4.x/include/apr_network_io.h
    apr/apr/branches/1.4.x/include/apr_thread_proc.h
    apr/apr/branches/1.4.x/include/apr_want.h

Modified: apr/apr/branches/1.4.x/include/apr_file_io.h
URL: http://svn.apache.org/viewvc/apr/apr/branches/1.4.x/include/apr_file_io.h?rev=896402&r1=896401&r2=896402&view=diff
==============================================================================
--- apr/apr/branches/1.4.x/include/apr_file_io.h (original)
+++ apr/apr/branches/1.4.x/include/apr_file_io.h Wed Jan  6 11:36:50 2010
@@ -674,6 +674,7 @@
  * @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
@@ -692,7 +693,7 @@
 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.

Modified: apr/apr/branches/1.4.x/include/apr_network_io.h
URL: http://svn.apache.org/viewvc/apr/apr/branches/1.4.x/include/apr_network_io.h?rev=896402&r1=896401&r2=896402&view=diff
==============================================================================
--- apr/apr/branches/1.4.x/include/apr_network_io.h (original)
+++ apr/apr/branches/1.4.x/include/apr_network_io.h Wed Jan  6 11:36:50 2010
@@ -353,7 +353,7 @@
  * return APR_EOF), if the socket's receive buffer is empty.  This
  * function does not block waiting for I/O.
  *
- * @param socket The socket to check
+ * @param sock The socket to check
  * @param atreadeof If APR_SUCCESS is returned, *atreadeof is set to
  *                  non-zero if a subsequent read would return APR_EOF
  * @return an error is returned if it was not possible to determine the
@@ -524,9 +524,10 @@
 
 /**
  * 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

Modified: apr/apr/branches/1.4.x/include/apr_thread_proc.h
URL: http://svn.apache.org/viewvc/apr/apr/branches/1.4.x/include/apr_thread_proc.h?rev=896402&r1=896401&r2=896402&view=diff
==============================================================================
--- apr/apr/branches/1.4.x/include/apr_thread_proc.h (original)
+++ apr/apr/branches/1.4.x/include/apr_thread_proc.h Wed Jan  6 11:36:50 2010
@@ -730,13 +730,13 @@
  * <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>
  */

Modified: apr/apr/branches/1.4.x/include/apr_want.h
URL: http://svn.apache.org/viewvc/apr/apr/branches/1.4.x/include/apr_want.h?rev=896402&r1=896401&r2=896402&view=diff
==============================================================================
--- apr/apr/branches/1.4.x/include/apr_want.h (original)
+++ apr/apr/branches/1.4.x/include/apr_want.h Wed Jan  6 11:36:50 2010
@@ -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.
  *