rbb 00/12/03 21:50:45
Modified: include apr_getopt.h
Log:
Cleanup getopt's docs.
Revision Changes Path
1.28 +8 -4 apr/include/apr_getopt.h
Index: apr_getopt.h
===================================================================
RCS file: /home/cvs/apr/include/apr_getopt.h,v
retrieving revision 1.27
retrieving revision 1.28
diff -u -r1.27 -r1.28
--- apr_getopt.h 2000/11/29 07:41:26 1.27
+++ apr_getopt.h 2000/12/04 05:50:44 1.28
@@ -84,13 +84,17 @@
char const* place;
/** set to nonzero to support interleaving options with regular args */
int interleave;
- /** range of non-option arguments skipped for interleaving */
+ /** start of non-option arguments skipped for interleaving */
int skip_start;
+ /** end of non-option arguments skipped for interleaving */
int skip_end;
};
typedef struct apr_getopt_option_t apr_getopt_option_t;
+/**
+ * Structure used to describe options that getopt should search for.
+ */
struct apr_getopt_option_t {
/** long option name, or NULL if option has no long name */
const char *name;
@@ -102,8 +106,8 @@
/**
* Initialize the arguments for parsing by apr_getopt().
- * @param cont The pool to operate on
* @param os The options structure created for apr_getopt()
+ * @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)
@@ -120,7 +124,7 @@
* option associated
* @param optch The next option character parsed
* @param optarg The argument following the option character:
- * @tip There are four potential status values on exit. They are:
+ * @return There are four potential status values on exit. They are:
* <PRE>
* APR_EOF -- No more options to parse
* APR_BADCH -- Found a bad option character
@@ -144,7 +148,7 @@
* @param optch Receives the value of "optch" from the apr_getopt_option_t
* structure corresponding to the next option matched.
* @param optarg Receives the argument following the option, if any.
- * @tip There are four potential status values on exit. They are:
+ * @return There are four potential status values on exit. They are:
* <PRE>
* APR_EOF -- No more options to parse
* APR_BADCH -- Found a bad option character
