aboutsummaryrefslogtreecommitdiffstats
path: root/info
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2013-08-01 12:18:14 +0200
committerMattias Andrée <maandree@operamail.com>2013-08-01 12:18:14 +0200
commitecf8ed70a98e093c47a045726933dc9044f3052b (patch)
tree2c4c28ef8e25facb072e1c687eac8ea891b48c51 /info
parentm (diff)
downloadargparser-ecf8ed70a98e093c47a045726933dc9044f3052b.tar.gz
argparser-ecf8ed70a98e093c47a045726933dc9044f3052b.tar.bz2
argparser-ecf8ed70a98e093c47a045726933dc9044f3052b.tar.xz
doc java version
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to '')
-rw-r--r--info/argparser.texinfo12
1 files changed, 12 insertions, 0 deletions
diff --git a/info/argparser.texinfo b/info/argparser.texinfo
index 8cd113a..f0b4e10 100644
--- a/info/argparser.texinfo
+++ b/info/argparser.texinfo
@@ -187,6 +187,18 @@ without @var{max} is named @code{testFilesMin}.
and @var{opts} is a @code{HashMap<String, String[]>}.
@var{argcount} does not exist.
+To populate the @code{ArgParser} with valid options, use the method
+@code{add} with the option and optional, before or after, the description.
+An option is created using a constructor for either @code{Argumentless},
+@code{Argumented} or @code{Variadic}.
+@code{Argumentless}'s constructor takes an @code{String[]} of alternatives
+and optional, before or after, the index of the primary alternative. If
+the index is not after the alternative array, the alternatives parameter
+is variadic and each alternative can be an argument.
+@code{Argumentless}'s constructor and @code{Variadic}'s constructor also
+takes a descriptive short name of a argument associated with the option
+optioned anywhere, and the alterantive array is variadic if places last.
+
@c@node Bash version