aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2013-08-01 04:31:07 +0200
committerMattias Andrée <maandree@operamail.com>2013-08-01 04:31:07 +0200
commita6d857c2bd09bdff3a7b4473d312451f5fd28f87 (patch)
tree7eba21b6be9ad2d35d9f8c6ebf07322d67468361
parentimporting argparser in java (diff)
downloadargparser-a6d857c2bd09bdff3a7b4473d312451f5fd28f87.tar.gz
argparser-a6d857c2bd09bdff3a7b4473d312451f5fd28f87.tar.bz2
argparser-a6d857c2bd09bdff3a7b4473d312451f5fd28f87.tar.xz
doc the java part that is similar to in python
Signed-off-by: Mattias Andrée <maandree@operamail.com>
-rw-r--r--info/argparser.texinfo19
1 files changed, 19 insertions, 0 deletions
diff --git a/info/argparser.texinfo b/info/argparser.texinfo
index f374340..8cd113a 100644
--- a/info/argparser.texinfo
+++ b/info/argparser.texinfo
@@ -168,6 +168,25 @@ options invoke the nulladic method @code{help}.
The JAR for ArgParser, @file{ArgParser.jar}, is located in @file{/usr/lib}.
When using it you need to import @code{argparser.ArgParser}.
+@code{ArgParser} has six constructors, conforming to:
+@code{description, usage, [longDescription, [program]], [useStderr]}.
+These correspond to those in the Python version.
+
+@code{ArgParser.parent_name} from the Python version is named
+@code{ArgParser.parentName} in the Java version and is identical
+except it parses Java invocation rather then Python invocation.
+Further @code{support_alternatives}, @code{test_exclusiveness},
+@code{test_allowed}, @code{test_files} and @code{help} are named
+@code{supportAlternatives}, @code{testExclusiveness}, @code{testAllowed},
+@code{testFiles} and @code{help} respectively and @code{testFiles}
+without @var{min} is named @code{testFilesMax} and @code{testFiles}
+without @var{max} is named @code{testFilesMin}.
+
+@var{message} is a @code{String}, @var{files} is a @code{ArrayList<String>},
+@var{unrecognisedCount} is a @code{int}, @var{arguments} is a @code{String[]},
+and @var{opts} is a @code{HashMap<String, String[]>}.
+@var{argcount} does not exist.
+
@c@node Bash version