Skip to content

Commit cbeb47f

Browse files
author
John Keyes
committed
documentation updates in preperation for the release
git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/cli/trunk@129823 13f79535-47bb-0310-9956-ffa450edef68
1 parent c8aa5fb commit cbeb47f

7 files changed

Lines changed: 316 additions & 224 deletions

File tree

‎xdocs/ant.xml‎

Lines changed: 0 additions & 44 deletions
This file was deleted.

‎xdocs/creation.xml‎

Lines changed: 0 additions & 64 deletions
This file was deleted.

‎xdocs/introduction.xml‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,9 @@
3030
<code>Options</code>.
3131
</p>
3232
<p>
33-
The <a href="usage.html">Simple Example</a> document provides examples
34-
how to create an <code>Options</code> object.
33+
The <a href="usage.html">Usage Scenarios</a> document provides
34+
examples how to create an <code>Options</code> object and also
35+
provides some real world examples.
3536
</p>
3637
<p>
3738
The result of the definition stage is an <code>Options</code>
@@ -72,7 +73,7 @@
7273
to the user code.
7374
</p>
7475
<p>
75-
The <a href="usage.html">Simple Example</a> document provides examples
76+
The <a href="usage.html">Usage Scenarios</a> document provides examples
7677
how to create an <code>Options</code> object.
7778
</p>
7879
<p>

‎xdocs/navigation.xml‎

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,9 @@
55

66
<body>
77
<menu name="User Documentation">
8-
<item name="Command Line Processing" href="/introduction.html"/>
9-
<item name="Option">
10-
<item name="Properties" href="/properties.html"/>
11-
<item name="Construction" href="/creation.html"/>
12-
<item name="Simple Example" href="/usage.html"/>
13-
</item>
14-
<item name="Command Line Parser" href="/parser.html"/>
8+
<item name="Introduction" href="/introduction.html"/>
9+
<item name="Usage Scenarios" href="/usage.html"/>
10+
<item name="Option Properties" href="/properties.html"/>
1511
</menu>
1612
</body>
1713
</project>

‎xdocs/parser.xml‎

Lines changed: 0 additions & 58 deletions
This file was deleted.

‎xdocs/properties.xml‎

Lines changed: 40 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,18 @@
22
<document>
33

44
<properties>
5-
<author email="jbjk@mac.com">John Keyes</author>
6-
<title>Option</title>
5+
<author email="john@integralsource.com">John Keyes</author>
6+
<title>Option Properties</title>
77
</properties>
88

99
<body>
1010
<section name="Option Properties">
1111
<p>
12-
The following are the properties of an <a href="apidocs/org/apache/commons/cli/Option.html">Option</a>.
12+
The following are the properties that each
13+
<a href="apidocs/org/apache/commons/cli/Options.html">Option</a> has. All of these
14+
can be set using the accessors or using the methods
15+
defined on the
16+
<a href="apidocs/org/apache/commons/cli/OptionBuilder.html">OptionBuilder</a>.
1317
</p>
1418
<table>
1519
<tr>
@@ -18,49 +22,72 @@
1822
<th>Description</th>
1923
</tr>
2024
<tr>
21-
<td>Opt</td>
25+
<td>opt</td>
2226
<td>java.lang.String</td>
23-
<td>the identification string</td>
27+
<td>the identification string of the Option.</td>
2428
</tr>
2529
<tr>
26-
<td>LongOpt</td>
30+
<td>longOpt</td>
2731
<td>java.lang.String</td>
2832
<td>an alias and more descriptive identification string</td>
2933
</tr>
3034
<tr>
31-
<td>Description</td>
35+
<td>description</td>
3236
<td>java.lang.String</td>
3337
<td>a description of the function of the option</td>
3438
</tr>
3539
<tr>
36-
<td>Required</td>
40+
<td>required</td>
3741
<td>boolean</td>
3842
<td>a flag to say whether the option <b>must</b> appear on
3943
the command line.</td>
4044
</tr>
4145
<tr>
42-
<td>MultipleArgs</td>
46+
<td>multipleArgs</td>
4347
<td>boolean</td>
4448
<td>a flag to say whether the option takes multiple argument
4549
values</td>
4650
</tr>
4751
<tr>
48-
<td>Arg</td>
52+
<td>arg</td>
4953
<td>boolean</td>
5054
<td>a flag to say whether the option takes an argument</td>
5155
</tr>
5256
<tr>
53-
<td>Type</td>
57+
<td>args</td>
58+
<td>boolean</td>
59+
<td>a flag to say whether the option takes more than one argument</td>
60+
</tr>
61+
<tr>
62+
<td>optionalArg</td>
63+
<td>boolean</td>
64+
<td>a flag to say whether the option's argument is optional</td>
65+
</tr>
66+
<tr>
67+
<td>argName</td>
68+
<td>java.lang.String</td>
69+
<td>the name of the argument value for the usage statement</td>
70+
</tr>
71+
<tr>
72+
<td>valueSeparator</td>
73+
<td>char</td>
74+
<td>the character value used to split the argument string, that
75+
is used in conjunction with multipleArgs e.g.
76+
if the separator is ',' and the argument string is 'a,b,c' then
77+
there are three argument values, 'a', 'b' and 'c'.</td>
78+
</tr>
79+
<tr>
80+
<td>type</td>
5481
<td>java.lang.Object</td>
5582
<td>the type of the argument</td>
5683
</tr>
5784
<tr>
58-
<td>Value</td>
85+
<td>value</td>
5986
<td>java.lang.String</td>
6087
<td>the value of the option</td>
6188
</tr>
6289
<tr>
63-
<td>Values</td>
90+
<td>values</td>
6491
<td>java.lang.String[]</td>
6592
<td>the values of the option</td>
6693
</tr>

0 commit comments

Comments
 (0)