apr-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From minf...@apache.org
Subject svn commit: r896382 - in /apr/apr/trunk/include: apr_buckets.h apr_file_io.h apr_ldap.h.in apr_memcache.h apr_network_io.h apr_thread_proc.h apr_want.h apr_xml.h
Date Wed, 06 Jan 2010 10:49:37 GMT
Author: minfrin
Date: Wed Jan  6 10:49:36 2010
New Revision: 896382

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

Modified:
    apr/apr/trunk/include/apr_buckets.h
    apr/apr/trunk/include/apr_file_io.h
    apr/apr/trunk/include/apr_ldap.h.in
    apr/apr/trunk/include/apr_memcache.h
    apr/apr/trunk/include/apr_network_io.h
    apr/apr/trunk/include/apr_thread_proc.h
    apr/apr/trunk/include/apr_want.h
    apr/apr/trunk/include/apr_xml.h

Modified: apr/apr/trunk/include/apr_buckets.h
URL: http://svn.apache.org/viewvc/apr/apr/trunk/include/apr_buckets.h?rev=896382&r1=896381&r2=896382&view=diff
==============================================================================
--- apr/apr/trunk/include/apr_buckets.h (original)
+++ apr/apr/trunk/include/apr_buckets.h Wed Jan  6 10:49:36 2010
@@ -659,14 +659,14 @@
                                                      apr_bucket_alloc_t *list);
 
 /**
- * destroy an entire bucket brigade.  This includes destroying all of the
+ * Destroy an entire bucket brigade.  This includes destroying all of the
  * buckets within the bucket brigade's bucket list. 
  * @param b The bucket brigade to destroy
  */
 APR_DECLARE(apr_status_t) apr_brigade_destroy(apr_bucket_brigade *b);
 
 /**
- * empty out an entire bucket brigade.  This includes destroying all of the
+ * Empty out an entire bucket brigade.  This includes destroying all of the
  * buckets within the bucket brigade's bucket list.  This is similar to
  * apr_brigade_destroy(), except that it does not deregister the brigade's
  * pool cleanup function.
@@ -679,10 +679,11 @@
 APR_DECLARE(apr_status_t) apr_brigade_cleanup(void *data);
 
 /**
- * Move the buckets from the tail end of the existing brigade @param b into
- * the brigade @param a. If @param a is NULL a new brigade is created. Buckets
- * from @param e to the last bucket (inclusively) of brigade @param b are moved
- * from @param b to the returned brigade @param a.
+ * Move the buckets from the tail end of the existing brigade @a b into
+ * the brigade @a a. If @a a is NULL a new brigade is created. Buckets
+ * from @a e to the last bucket (inclusively) of brigade @a b are moved
+ * from @a b to the returned brigade @a a.
+ *
  * @param b The brigade to split
  * @param e The first bucket to move
  * @param a The brigade which should be used for the result or NULL if
@@ -774,7 +775,7 @@
                                                  apr_off_t maxbytes);
 
 /**
- * create an iovec of the elements in a bucket_brigade... return number 
+ * Create an iovec of the elements in a bucket_brigade... return number 
  * of elements used.  This is useful for writing to a file or to the
  * network efficiently.
  * @param b The bucket brigade to create the iovec from

Modified: apr/apr/trunk/include/apr_file_io.h
URL: http://svn.apache.org/viewvc/apr/apr/trunk/include/apr_file_io.h?rev=896382&r1=896381&r2=896382&view=diff
==============================================================================
--- apr/apr/trunk/include/apr_file_io.h (original)
+++ apr/apr/trunk/include/apr_file_io.h Wed Jan  6 10:49:36 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/trunk/include/apr_ldap.h.in
URL: http://svn.apache.org/viewvc/apr/apr/trunk/include/apr_ldap.h.in?rev=896382&r1=896381&r2=896382&view=diff
==============================================================================
--- apr/apr/trunk/include/apr_ldap.h.in (original)
+++ apr/apr/trunk/include/apr_ldap.h.in Wed Jan  6 10:49:36 2010
@@ -192,6 +192,6 @@
 #include "apr_ldap_option.h"
 #include "apr_ldap_rebind.h"
 
-/** @} */
 #endif /* APR_HAS_LDAP */
+/** @} */
 #endif /* APU_LDAP_H */

Modified: apr/apr/trunk/include/apr_memcache.h
URL: http://svn.apache.org/viewvc/apr/apr/trunk/include/apr_memcache.h?rev=896382&r1=896381&r2=896382&view=diff
==============================================================================
--- apr/apr/trunk/include/apr_memcache.h (original)
+++ apr/apr/trunk/include/apr_memcache.h Wed Jan  6 10:49:36 2010
@@ -120,6 +120,7 @@
 
 /**
  * Creates a crc32 hash used to split keys between servers
+ * @param mc The memcache client object to use
  * @param data Data to be hashed
  * @param data_len Length of the data to use
  * @return crc32 hash of data
@@ -164,7 +165,7 @@
 /**
  * Adds a server to a client object
  * @param mc The memcache client object to use
- * @param ms Server to add
+ * @param server Server to add
  * @remark Adding servers is not thread safe, and should be done once at startup.
  * @warning Changing servers after startup may cause keys to go to
  * different servers.
@@ -284,7 +285,7 @@
  * @param mc client to use
  * @param key   null terminated string containing the key
  * @param baton data to store on the server
- * @param len   length of data at baton
+ * @param data_size   length of data at baton
  * @param timeout time in seconds for the data to live on the server
  * @param flags any flags set by the client for this key
  */
@@ -300,7 +301,7 @@
  * @param mc client to use
  * @param key   null terminated string containing the key
  * @param baton data to store on the server
- * @param len   length of data at baton
+ * @param data_size   length of data at baton
  * @param timeout time for the data to live on the server
  * @param flags any flags set by the client for this key
  * @return APR_SUCCESS if the key was added, APR_EEXIST if the key 
@@ -318,7 +319,7 @@
  * @param mc client to use
  * @param key   null terminated string containing the key
  * @param baton data to store on the server
- * @param len   length of data at baton
+ * @param data_size   length of data at baton
  * @param timeout time for the data to live on the server
  * @param flags any flags set by the client for this key
  * @return APR_SUCCESS if the key was added, APR_EEXIST if the key 
@@ -326,7 +327,7 @@
  */
 APR_DECLARE(apr_status_t) apr_memcache_replace(apr_memcache_t *mc,
                                                const char *key,
-                                               char *data,
+                                               char *baton,
                                                const apr_size_t data_size,
                                                apr_uint32_t timeout,
                                                apr_uint16_t flags);
@@ -357,7 +358,7 @@
  * @param mc client to use
  * @param key   null terminated string containing the key
  * @param n     number to decrement by
- * @param nv    new value after decrementing
+ * @param new_value    new value after decrementing
  */
 APR_DECLARE(apr_status_t) apr_memcache_decr(apr_memcache_t *mc, 
                                             const char *key,

Modified: apr/apr/trunk/include/apr_network_io.h
URL: http://svn.apache.org/viewvc/apr/apr/trunk/include/apr_network_io.h?rev=896382&r1=896381&r2=896382&view=diff
==============================================================================
--- apr/apr/trunk/include/apr_network_io.h (original)
+++ apr/apr/trunk/include/apr_network_io.h Wed Jan  6 10:49:36 2010
@@ -380,7 +380,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
@@ -553,9 +553,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/trunk/include/apr_thread_proc.h
URL: http://svn.apache.org/viewvc/apr/apr/trunk/include/apr_thread_proc.h?rev=896382&r1=896381&r2=896382&view=diff
==============================================================================
--- apr/apr/trunk/include/apr_thread_proc.h (original)
+++ apr/apr/trunk/include/apr_thread_proc.h Wed Jan  6 10:49:36 2010
@@ -738,13 +738,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/trunk/include/apr_want.h
URL: http://svn.apache.org/viewvc/apr/apr/trunk/include/apr_want.h?rev=896382&r1=896381&r2=896382&view=diff
==============================================================================
--- apr/apr/trunk/include/apr_want.h (original)
+++ apr/apr/trunk/include/apr_want.h Wed Jan  6 10:49:36 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.
  *

Modified: apr/apr/trunk/include/apr_xml.h
URL: http://svn.apache.org/viewvc/apr/apr/trunk/include/apr_xml.h?rev=896382&r1=896381&r2=896382&view=diff
==============================================================================
--- apr/apr/trunk/include/apr_xml.h (original)
+++ apr/apr/trunk/include/apr_xml.h Wed Jan  6 10:49:36 2010
@@ -304,10 +304,10 @@
 
 /**
  * quote an XML string
- * Replace '<', '>', and '&' with '&lt;', '&gt;', and '&amp;'.
+ * Replace '\<', '\>', and '\&' with '\&lt;', '\&gt;', and '\&amp;'.
  * @param p The pool to allocate out of
  * @param s The string to quote
- * @param quotes If quotes is true, then replace '"' with '&quot;'.
+ * @param quotes If quotes is true, then replace '&quot;' with '\&quot;'.
  * @return The quoted string
  * @note If the string does not contain special characters, it is not
  * duplicated into the pool and the original string is returned.



Mime
View raw message