diff options
Diffstat (limited to 'lib/libc/include/plgetopt.h')
| -rw-r--r-- | lib/libc/include/plgetopt.h | 56 |
1 files changed, 28 insertions, 28 deletions
diff --git a/lib/libc/include/plgetopt.h b/lib/libc/include/plgetopt.h index 19cafa60..87891e85 100644 --- a/lib/libc/include/plgetopt.h +++ b/lib/libc/include/plgetopt.h @@ -16,7 +16,7 @@ PR_BEGIN_EXTERN_C -typedef struct PLOptionInternal PLOptionInternal; +typedef struct PLOptionInternal PLOptionInternal; typedef enum { @@ -47,26 +47,26 @@ typedef struct PLOptState /* * PL_CreateOptState * - * The argument "options" points to a string of single-character option - * names. Option names that may have an option argument value must be - * followed immediately by a ':' character. + * The argument "options" points to a string of single-character option + * names. Option names that may have an option argument value must be + * followed immediately by a ':' character. */ PR_EXTERN(PLOptState*) PL_CreateOptState( PRIntn argc, char **argv, const char *options); -/* +/* * PL_CreateLongOptState * - * Alternative to PL_CreateOptState. - * Allows caller to specify BOTH a string of single-character option names, - * AND an array of structures describing "long" (keyword) option names. - * The array is terminated by a structure in which longOptName is NULL. + * Alternative to PL_CreateOptState. + * Allows caller to specify BOTH a string of single-character option names, + * AND an array of structures describing "long" (keyword) option names. + * The array is terminated by a structure in which longOptName is NULL. * Long option values (arguments) may always be given as "--name=value". - * If PLLongOpt.valueRequired is not PR_FALSE, and the option name was not - * followed by '=' then the next argument from argv is taken as the value. + * If PLLongOpt.valueRequired is not PR_FALSE, and the option name was not + * followed by '=' then the next argument from argv is taken as the value. */ PR_EXTERN(PLOptState*) PL_CreateLongOptState( - PRIntn argc, char **argv, const char *options, + PRIntn argc, char **argv, const char *options, const PLLongOpt *longOpts); /* * PL_DestroyOptState @@ -79,39 +79,39 @@ PR_EXTERN(void) PL_DestroyOptState(PLOptState *opt); /* * PL_GetNextOpt * - * When this function returns PL_OPT_OK, - * - opt->option will hold the single-character option name that was parsed, - * or zero. - * When opt->option is zero, the token parsed was either a "long" (keyword) - * option or a positional parameter. - * For a positional parameter, + * When this function returns PL_OPT_OK, + * - opt->option will hold the single-character option name that was parsed, + * or zero. + * When opt->option is zero, the token parsed was either a "long" (keyword) + * option or a positional parameter. + * For a positional parameter, * - opt->longOptIndex will contain -1, and * - opt->value will point to the positional parameter string. - * For a long option name, - * - opt->longOptIndex will contain the non-negative index of the - * PLLongOpt structure in the caller's array of PLLongOpt structures - * corresponding to the long option name, and - * For a single-character or long option, + * For a long option name, + * - opt->longOptIndex will contain the non-negative index of the + * PLLongOpt structure in the caller's array of PLLongOpt structures + * corresponding to the long option name, and + * For a single-character or long option, * - opt->longOption will contain the value of the single-character option * name, or the value of the longOption from the PLLongOpt structure * for that long option. See notes below. * - opt->value will point to the argument option string, or will * be NULL if option does not require argument. If option requires * argument but it is not provided, PL_OPT_BAD is returned. - * When opt->option is non-zero, + * When opt->option is non-zero, * - opt->longOptIndex will be -1 * When this function returns PL_OPT_EOL, or PL_OPT_BAD, the contents of * opt are undefined. * - * Notes: It is possible to ignore opt->option, and always look at + * Notes: It is possible to ignore opt->option, and always look at * opt->longOption instead. opt->longOption will contain the same value * as opt->option for single-character option names, and will contain the * value of longOption from the PLLongOpt structure for long option names. - * This means that it is possible to equivalence long option names to + * This means that it is possible to equivalence long option names to * single character names by giving the longOption in the PLLongOpt struct - * the same value as the single-character option name. + * the same value as the single-character option name. * For long options that are NOT intended to be equivalent to any single- - * character option, the longOption value should be chosen to not match + * character option, the longOption value should be chosen to not match * any possible single character name. It might be advisable to choose * longOption values greater than 0xff for such long options. */ |