Hi,
here is a patch against APR in order to fix most of the doxygen warnings.
Note that I have updated a function prototype in apr_md5.h in order to
match the corresponding function in apr_md5.c. s/password/pw/
I have also turned some @tip into @note because @tip is not a known
keyword for doxygen.
Best regards,
CJ
Index: include/apr_dbd.h
===================================================================
--- include/apr_dbd.h (révision 1611200)
+++ include/apr_dbd.h (copie de travail)
@@ -231,7 +231,7 @@
* May be a no-op.
*
* @param driver - the driver
- * @param handle - the db connection
+ * @param pool - working pool
* @param trans - the transaction.
* @return 0 for success or error code
*/
Index: include/apr_md5.h
===================================================================
--- include/apr_md5.h (révision 1611200)
+++ include/apr_md5.h (copie de travail)
@@ -131,17 +131,17 @@
/**
* Encode a password using an MD5 algorithm
- * @param password The password to encode
+ * @param pw The password to encode
* @param salt The salt string to use for the encoding
* @param result The string to store the encoded password in
* @param nbytes The size of the result buffer
*/
-APR_DECLARE(apr_status_t) apr_md5_encode(const char *password, const char
*salt,
+APR_DECLARE(apr_status_t) apr_md5_encode(const char *pw, const char *salt,
char *result, apr_size_t nbytes);
/**
* Encode a password using the bcrypt algorithm
- * @param password The password to encode
+ * @param pw The password to encode
* @param count The cost of the encoding, possible values are 4 to 31
* @param salt Pointer to binary data to be used as salt for the encoding
* @param salt_len The size of the salt data (must be >= 16)
Index: include/apr_memcache.h
===================================================================
--- include/apr_memcache.h (révision 1611200)
+++ include/apr_memcache.h (copie de travail)
@@ -370,7 +370,6 @@
* @param ms server to query
* @param p Pool to allocate answer from
* @param baton location to store server version string
- * @param len length of the server version string
*/
APR_DECLARE(apr_status_t) apr_memcache_version(apr_memcache_server_t *ms,
apr_pool_t *p,
Index: include/apr_network_io.h
===================================================================
--- include/apr_network_io.h (révision 1611200)
+++ include/apr_network_io.h (copie de travail)
@@ -750,8 +750,10 @@
apr_sockaddr_t *sockaddr);
/**
- * Write the IP address (in numeric address string format) of the APR
- * socket address @a sockaddr into the buffer @a buf (of size @a buflen).
+ * Write the IP address (in numeric address string format) of an APR
+ * socket address.
+ * @param buf The buffer to write to.
+ * @param buflen The size of the buffer.
* @param sockaddr The socket address to reference.
*/
APR_DECLARE(apr_status_t) apr_sockaddr_ip_getbuf(char *buf, apr_size_t buflen,
Index: include/apr_pools.h
===================================================================
--- include/apr_pools.h (révision 1611200)
+++ include/apr_pools.h (copie de travail)
@@ -727,7 +727,7 @@
* In this case the caller must call apr_pool_join() to indicate this
* guarantee to the APR_POOL_DEBUG code.
*
- * These functions are only implemented when #APR_POOL_DEBUG is set.
+ * These functions are only implemented when APR_POOL_DEBUG is set.
*
* @{
*/
Index: include/apr_thread_pool.h
===================================================================
--- include/apr_thread_pool.h (révision 1611200)
+++ include/apr_thread_pool.h (copie de travail)
@@ -267,7 +267,7 @@
/**
* Access function for the threshold of tasks in queue to trigger a new thread.
* @param me The thread pool
- * @param cnt The new threshold
+ * @param val The new threshold
* @return The original threshold
*/
APR_DECLARE(apr_size_t) apr_thread_pool_threshold_set(apr_thread_pool_t *me,
Index: include/arch/win32/apr_arch_utf8.h
===================================================================
--- include/arch/win32/apr_arch_utf8.h (révision 1611200)
+++ include/arch/win32/apr_arch_utf8.h (copie de travail)
@@ -30,7 +30,7 @@
* to the ucs-2 wide Unicode format. This function is used for filename and
* other resource conversions for platforms providing native Unicode support.
*
- * @tip Only the errors APR_EINVAL and APR_INCOMPLETE may occur, the former
+ * @note Only the errors APR_EINVAL and APR_INCOMPLETE may occur, the former
* when the character code is invalid (in or out of context) and the later
* when more characters were expected, but insufficient characters remain.
*/
@@ -44,7 +44,7 @@
* the utf-8 octet-encoded Unicode. This function is used for filename and
* other resource conversions for platforms providing native Unicode support.
*
- * @tip Only the errors APR_EINVAL and APR_INCOMPLETE may occur, the former
+ * @note Only the errors APR_EINVAL and APR_INCOMPLETE may occur, the former
* when the character code is invalid (in or out of context) and the later
* when more words were expected, but insufficient words remain.
*/
