Hello
While reading the generated docs I saw that a few descriptions are messed
up. The cause is the use of @param in text instead of @a.
Here's a log message and patch to fix this.
Thanks,
Martin
PS: Please CC me, I'm not on the list.
[[[
Replace @param by @a in doxygen texts.
]]]
[[[
Index: include/apr_buckets.h
===================================================================
--- include/apr_buckets.h (revision 883021)
+++ include/apr_buckets.h (working copy)
@@ -679,16 +679,16 @@
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
* a new brigade should be created.
- * @return The brigade supplied in @param a or a new one if @param a was NULL.
- * @warning Note that this function allocates a new brigade if @param a is
+ * @return The brigade supplied in @a a or a new one if @a a was NULL.
+ * @warning Note that this function allocates a new brigade if @a a is
* NULL so memory consumption should be carefully considered.
*/
APR_DECLARE(apr_bucket_brigade *) apr_brigade_split_ex(apr_bucket_brigade *b,
@@ -698,8 +698,8 @@
/**
* Create a new bucket brigade and move the buckets from the tail end
* of an existing brigade into the new brigade. Buckets from
- * @param e to the last bucket (inclusively) of brigade @param b
- * are moved from @param b to the returned brigade.
+ * @param e to the last bucket (inclusively) of brigade @a b
+ * are moved from @a b to the returned brigade.
* @param b The brigade to split
* @param e The first bucket to move
* @return The new brigade
Index: include/apr_tables.h
===================================================================
--- include/apr_tables.h (revision 883021)
+++ include/apr_tables.h (working copy)
@@ -364,11 +364,11 @@
* Iterate over a table running the provided function once for every
* element in the table. The varargs array must be a list of zero or
* more (char *) keys followed by a NULL pointer. If zero keys are
- * given, the @param comp function will be invoked for every element
+ * given, the @a comp function will be invoked for every element
* in the table. Otherwise, the function is invoked only for those
* elements matching the keys specified.
*
- * If an invocation of the @param comp function returns zero,
+ * If an invocation of the @a comp function returns zero,
* iteration will continue using the next specified key, if any.
*
* @param comp The function to run
@@ -388,13 +388,13 @@
/**
* Iterate over a table running the provided function once for every
- * element in the table. The @param vp varargs parameter must be a
+ * element in the table. The @a vp varargs parameter must be a
* list of zero or more (char *) keys followed by a NULL pointer. If
- * zero keys are given, the @param comp function will be invoked for
+ * zero keys are given, the @a comp function will be invoked for
* every element in the table. Otherwise, the function is invoked
* only for those elements matching the keys specified.
*
- * If an invocation of the @param comp function returns zero,
+ * If an invocation of the @a comp function returns zero,
* iteration will continue using the next specified key, if any.
*
* @param comp The function to run
Index: include/apr_rmm.h
===================================================================
--- include/apr_rmm.h (revision 883021)
+++ include/apr_rmm.h (working copy)
@@ -50,7 +50,7 @@
* @param membuf The block of relocatable memory to be managed
* @param memsize The size of relocatable memory block to be managed
* @param cont The pool to use for local storage and management
- * @remark Both @param membuf and @param memsize must be aligned
+ * @remark Both @a membuf and @a memsize must be aligned
* (for instance using APR_ALIGN_DEFAULT).
*/
APR_DECLARE(apr_status_t) apr_rmm_init(apr_rmm_t **rmm, apr_anylock_t *lock,
Index: include/apr_hash.h
===================================================================
--- include/apr_hash.h (revision 883021)
+++ include/apr_hash.h (working copy)
@@ -236,7 +236,7 @@
/**
* Iterate over a hash table running the provided function once for every
- * element in the hash table. The @param comp function will be invoked for
+ * element in the hash table. The @a comp function will be invoked for
* every element in the hash table.
*
* @param comp The function to run
Index: include/apr_network_io.h
===================================================================
--- include/apr_network_io.h (revision 883021)
+++ include/apr_network_io.h (working copy)
@@ -553,9 +553,9 @@
/**
* 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
]]]
