apr-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Ian Holsman <i...@cnet.com>
Subject [DOX] apr_getopt.h
Date Tue, 14 Aug 2001 02:23:43 GMT
OK..
another round of DOX patches.
(this would be easier if I had commit access)

..Ian
Index: include/apr_getopt.h
===================================================================
RCS file: /home/cvspublic/apr/include/apr_getopt.h,v
retrieving revision 1.33
diff -u -r1.33 apr_getopt.h
--- include/apr_getopt.h    2001/06/01 09:59:36    1.33
+++ include/apr_getopt.h    2001/08/14 02:17:06
@@ -60,10 +60,15 @@
 #ifdef __cplusplus
 extern "C" {
 #endif /* __cplusplus */
-
 /**
- * @package APR command arguments
- */
+ * @file apr_getopt.h
+ * @brief APR Command Arguments (getopt)
+ */
+/**
+ * @defgroup APR_getopt Command Argument Parsing
+ * @ingroup APR
+ * @{
+ */
 
 typedef struct apr_getopt_t apr_getopt_t;
 /**
@@ -114,8 +119,7 @@
  * @param cont The pool to operate on
  * @param argc The number of arguments to parse
  * @param argv The array of arguments to parse
- * @tip Arguments 2 and 3 are most commonly argc and argv from 
main(argc, argv)
- * @deffunc apr_status_t apr_getopt_init(apr_getopt_t **os, apr_pool_t 
*cont,int argc, char *const *argv)
+ * @remark Arguments 2 and 3 are most commonly argc and argv from 
main(argc, argv)
  */
 APR_DECLARE(apr_status_t) apr_getopt_init(apr_getopt_t **os, apr_pool_t 
*cont,
                                       int argc, const char * const *argv);
@@ -135,7 +139,6 @@
  *             APR_BADARG   --  No argument followed @parameter:
  *             APR_SUCCESS  --  The next option was found.
  * </PRE>
- * @deffunc apr_status_t apr_getopt(apr_getopt_t *os, const char *opts, 
char *optch, const char **optarg)
  */
 APR_DECLARE(apr_status_t) apr_getopt(apr_getopt_t *os, const char *opts,
                                      char *option_ch, const char 
**option_arg);
@@ -164,13 +167,12 @@
  * os->err is set to 0.  If os->interleave is set to nonzero, options 
can come
  * after arguments, and os->argv will be permuted to leave non-option 
arguments
  * at the end (the original argv is unaffected).
- * @deffunc apr_status_t apr_getopt_long(apr_getopt_t *os, const 
apr_getopt_option_t *opts, int *optch, const char **optarg)
  */
 APR_DECLARE(apr_status_t) apr_getopt_long(apr_getopt_t *os,
                       const apr_getopt_option_t *opts,
                       int *option_ch,
                                           const char **option_arg);
-
+/** @} */
 #ifdef __cplusplus
 }
 #endif


Mime
View raw message