X-Git-Url: http://git.efficios.com/?p=argpar.git;a=blobdiff_plain;f=argpar%2Fargpar.h;h=be715131d5628c3018393a7d436b92ae2744e4e7;hp=9da99d3324ead19564e0c2dbf4d6d0eccbf52c4c;hb=dd757a651292048da829dd6fa085c1f107569bcc;hpb=a473f6cbcce5fe68bf5038cab79170a4e165b9e6 diff --git a/argpar/argpar.h b/argpar/argpar.h index 9da99d3..be71513 100644 --- a/argpar/argpar.h +++ b/argpar/argpar.h @@ -67,10 +67,7 @@ * * * Non-option arguments (anything else). * - * The argpar parsers don't accept `-` or `--` as arguments. The latter - * means "end of options" for many command-line tools, but this library - * is all about keeping the order of the arguments, so it doesn't mean - * much to put them at the end. This has the side effect that a + * The argpar parsers parse `-` and `--` as non-option arguments. A * non-option argument cannot have the form of an option, for example if * you need to pass the exact relative path `--component`. In that case, * you would need to pass `./--component`. There's no generic way to @@ -128,7 +125,7 @@ struct argpar_opt_descr { /* Short option character, or `\0` */ const char short_name; - /* Long option name (without `--`), or `NULL` */ + /* Long option name (without the `--` prefix), or `NULL` */ const char * const long_name; /* True if this option has an argument */ @@ -290,7 +287,9 @@ void argpar_parse_ret_fini(struct argpar_parse_ret *ret); * actually start parsing the arguments. * * `*argv` and `*descrs` must NOT change for the lifetime of the - * returned iterator (until you call argpar_iter_destroy()). + * returned iterator (until you call argpar_iter_destroy()) and for the + * lifetime of any parsing item (until you call argpar_item_destroy()) + * argpar_iter_next() creates for the returned iterator. * * Call argpar_iter_next() with the returned iterator to obtain the next * parsing result (item).