apr-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From roo...@apache.org
Subject svn commit: r377527 - in /apr/apr/trunk/include: apr_getopt.h apr_poll.h apr_support.h
Date Mon, 13 Feb 2006 23:04:33 GMT
Author: rooneg
Date: Mon Feb 13 15:04:18 2006
New Revision: 377527

URL: http://svn.apache.org/viewcvs?rev=377527&view=rev
Log:
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.

Modified:
    apr/apr/trunk/include/apr_getopt.h
    apr/apr/trunk/include/apr_poll.h
    apr/apr/trunk/include/apr_support.h

Modified: apr/apr/trunk/include/apr_getopt.h
URL: http://svn.apache.org/viewcvs/apr/apr/trunk/include/apr_getopt.h?rev=377527&r1=377526&r2=377527&view=diff
==============================================================================
--- apr/apr/trunk/include/apr_getopt.h (original)
+++ apr/apr/trunk/include/apr_getopt.h Mon Feb 13 15:04:18 2006
@@ -35,7 +35,9 @@
  */
 
 /** 
- * 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 @@
  * @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);

Modified: apr/apr/trunk/include/apr_poll.h
URL: http://svn.apache.org/viewcvs/apr/apr/trunk/include/apr_poll.h?rev=377527&r1=377526&r2=377527&view=diff
==============================================================================
--- apr/apr/trunk/include/apr_poll.h (original)
+++ apr/apr/trunk/include/apr_poll.h Mon Feb 13 15:04:18 2006
@@ -171,7 +171,7 @@
  * Poll the descriptors in the poll structure
  * @param aprset The poll structure we will be using. 
  * @param numsock The number of descriptors we are polling
- * @param nsds The number of descriptors signalled.
+ * @param nsds The number of descriptors signalled (output parameter)
  * @param timeout The amount of time in microseconds to wait.  This is 
  *                a maximum, not a minimum.  If a descriptor is signalled, we 
  *                will wake up before this time.  A negative number means 

Modified: apr/apr/trunk/include/apr_support.h
URL: http://svn.apache.org/viewcvs/apr/apr/trunk/include/apr_support.h?rev=377527&r1=377526&r2=377527&view=diff
==============================================================================
--- apr/apr/trunk/include/apr_support.h (original)
+++ apr/apr/trunk/include/apr_support.h Mon Feb 13 15:04:18 2006
@@ -38,6 +38,12 @@
 
 /**
  * Wait for IO to occur or timeout.
+ *
+ * @param f The file to wait on.
+ * @param s The socket to wait on if @a f is @c NULL.
+ * @param for_read If non-zero wait for data to be available to read,
+ *        otherwise wait for data to be able to be written. 
+ * @return APR_TIMEUP if we run out of time.
  */
 apr_status_t apr_wait_for_io_or_timeout(apr_file_t *f, apr_socket_t *s,
                                         int for_read);



Mime
View raw message