apr-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From minf...@apache.org
Subject svn commit: r896405 - in /apr/apr-util/branches/1.4.x/include: apr_buckets.h apr_ldap.h.in apr_memcache.h apr_xml.h
Date Wed, 06 Jan 2010 11:39:17 GMT
Author: minfrin
Date: Wed Jan  6 11:39:11 2010
New Revision: 896405

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

Modified:
    apr/apr-util/branches/1.4.x/include/apr_buckets.h
    apr/apr-util/branches/1.4.x/include/apr_ldap.h.in
    apr/apr-util/branches/1.4.x/include/apr_memcache.h
    apr/apr-util/branches/1.4.x/include/apr_xml.h

Modified: apr/apr-util/branches/1.4.x/include/apr_buckets.h
URL: http://svn.apache.org/viewvc/apr/apr-util/branches/1.4.x/include/apr_buckets.h?rev=896405&r1=896404&r2=896405&view=diff
==============================================================================
--- apr/apr-util/branches/1.4.x/include/apr_buckets.h (original)
+++ apr/apr-util/branches/1.4.x/include/apr_buckets.h Wed Jan  6 11:39:11 2010
@@ -679,10 +679,11 @@
 APU_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-util/branches/1.4.x/include/apr_ldap.h.in
URL: http://svn.apache.org/viewvc/apr/apr-util/branches/1.4.x/include/apr_ldap.h.in?rev=896405&r1=896404&r2=896405&view=diff
==============================================================================
--- apr/apr-util/branches/1.4.x/include/apr_ldap.h.in (original)
+++ apr/apr-util/branches/1.4.x/include/apr_ldap.h.in Wed Jan  6 11:39:11 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-util/branches/1.4.x/include/apr_memcache.h
URL: http://svn.apache.org/viewvc/apr/apr-util/branches/1.4.x/include/apr_memcache.h?rev=896405&r1=896404&r2=896405&view=diff
==============================================================================
--- apr/apr-util/branches/1.4.x/include/apr_memcache.h (original)
+++ apr/apr-util/branches/1.4.x/include/apr_memcache.h Wed Jan  6 11:39:11 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 @@
  */
 APU_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
  */
 APU_DECLARE(apr_status_t) apr_memcache_decr(apr_memcache_t *mc, 
                                             const char *key,

Modified: apr/apr-util/branches/1.4.x/include/apr_xml.h
URL: http://svn.apache.org/viewvc/apr/apr-util/branches/1.4.x/include/apr_xml.h?rev=896405&r1=896404&r2=896405&view=diff
==============================================================================
--- apr/apr-util/branches/1.4.x/include/apr_xml.h (original)
+++ apr/apr-util/branches/1.4.x/include/apr_xml.h Wed Jan  6 11:39:11 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