Improve some documentation comments.

Based on a patch from: Julian Foad <julianfoad btopenworld.com>

* include/apr_getopt.h
  (apr_getopt_err_fn_t): Clarify, mention what the arg parameter is.
  (apr_getopt_init): Clarify how the error function is used.

* include/apr_poll.h
  (apr_poll): Note that nsds is an output parameter.

* include/apr_support.h
  (apr_wait_for_io_or_timeout): Document the arguments.


git-svn-id: https://svn.apache.org/repos/asf/apr/apr/trunk@377527 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 5 insertions, 3 deletions

diff --git a/include/apr_getopt.h b/include/apr_getopt.h
index 972e14e3c..b786cbd6d 100644
--- a/include/apr_getopt.h
+++ b/include/apr_getopt.h
@@ -35,7 +35,9 @@ extern "C" {
  */
 
 /** 
- * defintion of a error function 
+ * An @c apr_getopt_t error callback function.
+ *
+ * @a arg is this @c apr_getopt_t's @c errarg member.
  */
 typedef void (apr_getopt_err_fn_t)(void *arg, const char *err, ...);
 
@@ -95,8 +97,8 @@ struct apr_getopt_option_t {
  * @param cont The pool to operate on
  * @param argc The number of arguments to parse
  * @param argv The array of arguments to parse
- * @remark Arguments 2 and 3 are most commonly argc and argv from main(argc, argv)
- * The errfn is initialized to fprintf(stderr... but may be overridden.
+ * @remark Arguments 3 and 4 are most commonly argc and argv from main(argc, argv)
+ * The (*os)->errfn is initialized to fprintf(stderr... but may be overridden.
  */
 APR_DECLARE(apr_status_t) apr_getopt_init(apr_getopt_t **os, apr_pool_t *cont,
                                       int argc, const char * const *argv);