clean cliparser doc and add arg_dbl

This commit is contained in:
Philippe Teuwen 2020-10-04 15:13:32 +02:00
parent aa3d29e6ac
commit 7009f2ade7

View file

@ -107,25 +107,31 @@ Hence all options you add will start at index 1 and upwards._
**Notes:**
**bool option. true if supplied**
bool : arg_lit0 ("\<short option\>", "\<long option\>", \["\<format\>",\] \<"description"\>)
bool : arg_lit0 ("\<short option\>", "\<long option\>", \<"description"\>)
**integer that is optional**
optional integer : arg_int0 ("\<short option\>", "\<long option\>", \["\<format\>",\] \<"description"\>)
optional integer : arg_int0 ("\<short option\>", "\<long option\>", "\<format\>", \<"description"\>)
**integer that is required**
required integer : arg_int1 ("\<short option\>", "\<long option\>", \["\<format\>",\] \<"description"\>)
required integer : arg_int1 ("\<short option\>", "\<long option\>", "\<format\>", \<"description"\>)
**double that is optional**
optional double : arg_dbl0 ("\<short option\>", "\<long option\>", "\<format\>", \<"description"\>)
**double that is required**
required double : arg_dbl1 ("\<short option\>", "\<long option\>", "\<format\>", \<"description"\>)
**String option that is optional and only one instance can be provided**
optional string : arg_str0("\<short option\>", "\<long option\>", \["\<format\>",\] \<"description"\>)
optional string : arg_str0("\<short option\>", "\<long option\>", "\<format\>", \<"description"\>)
**String option that is required and only one instance can be provided**
required string : arg_str1("\<short option\>", "\<long option\>", \["\<format\>",\] \<"description"\>)
required string : arg_str1("\<short option\>", "\<long option\>", "\<format\>", \<"description"\>)
**String option that is optional and can have up to 250 instances provided**
optional string : arg_strx0 ("\<short option\>", "\<long option\>", \["\<format\>",\] \<"description"\>)
optional string : arg_strx0 ("\<short option\>", "\<long option\>", "\<format\>", \<"description"\>)
**String option that is required/at least one instance and can have up to 250 instances**
required string : arg_strx1 ("\<short option\>", "\<long option\>", \["\<format\>",\] \<"description"\>)
required string : arg_strx1 ("\<short option\>", "\<long option\>", "\<format\>", \<"description"\>)
**if an option does not have a short or long option, use NULL in its place**