Skip to content

Commit d85e036

Browse files
author
Robert James Oxspring
committed
Added initial cli2 manual stub
git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/cli/trunk@130079 13f79535-47bb-0310-9956-ffa450edef68
1 parent b329f16 commit d85e036

6 files changed

Lines changed: 254 additions & 0 deletions

File tree

‎xdocs/manual/builders.xml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
<?xml version="1.0"?>
2+
<!--
3+
Copyright 2004 The Apache Software Foundation
4+
5+
Licensed under the Apache License, Version 2.0 (the "License");
6+
you may not use this file except in compliance with the License.
7+
You may obtain a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.
16+
-->
17+
<document>
18+
19+
<properties>
20+
<author email="commons-dev@jakarta.apache.org">commons-dev</author>
21+
<title>CLI2 - Builders</title>
22+
</properties>
23+
24+
<body>
25+
<section name="Builders">
26+
<img src="../images/builders.jpg"/>
27+
<subsection name="GroupBuilder">
28+
</subsection>
29+
<subsection name="ArgumentBuilder">
30+
</subsection>
31+
<subsection name="DefaultOptionBuilder">
32+
</subsection>
33+
<subsection name="CommandBuilder">
34+
</subsection>
35+
<subsection name="SwitchBuilder">
36+
</subsection>
37+
<subsection name="PatternBuilder">
38+
</subsection>
39+
<subsection name="Other Options">
40+
<p>TODO PropertyOption</p>
41+
<p>TODO SourceDestArgument</p>
42+
</subsection>
43+
</section>
44+
</body>
45+
</document>

‎xdocs/manual/commandlines.xml‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
<?xml version="1.0"?>
2+
<!--
3+
Copyright 2004 The Apache Software Foundation
4+
5+
Licensed under the Apache License, Version 2.0 (the "License");
6+
you may not use this file except in compliance with the License.
7+
You may obtain a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.
16+
-->
17+
<document>
18+
19+
<properties>
20+
<author email="commons-dev@jakarta.apache.org">commons-dev</author>
21+
<title>CLI2 - CommandLines</title>
22+
</properties>
23+
24+
<body>
25+
<section name="CommandLines">
26+
<img src="../images/commandlines.jpg"/>
27+
<subsection name="Parser">
28+
</subsection>
29+
<subsection name="CommandLine">
30+
</subsection>
31+
<subsection name="WriteableCommandLine">
32+
</subsection>
33+
<subsection name="DefaultingCommandLine">
34+
</subsection>
35+
<subsection name="PropertiesCommandLine">
36+
</subsection>
37+
<subsection name="Command">
38+
</subsection>
39+
<subsection name="Switch">
40+
</subsection>
41+
<subsection name="PropertyOption">
42+
</subsection>
43+
<subsection name="SourceDestArgument">
44+
</subsection>
45+
</section>
46+
<section name="Future Work">
47+
<p>TODO commons-configuration</p>
48+
</section>
49+
</body>
50+
</document>

‎xdocs/manual/index.xml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<?xml version="1.0"?>
2+
<!--
3+
Copyright 2004 The Apache Software Foundation
4+
5+
Licensed under the Apache License, Version 2.0 (the "License");
6+
you may not use this file except in compliance with the License.
7+
You may obtain a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.
16+
-->
17+
<document>
18+
19+
<properties>
20+
<author email="commons-dev@jakarta.apache.org">commons-dev</author>
21+
<title>CLI2 - Overview</title>
22+
</properties>
23+
24+
<body>
25+
<section name="Overview">
26+
<p>TODO quick overview to the overview</p>
27+
<subsection name="Modelling the interface">
28+
<p>TODO terminology</p>
29+
<p>TODO basic options</p>
30+
<p>TODO option builders</p>
31+
</subsection>
32+
<subsection name="Parsing the command line">
33+
<p>TODO Parser</p>
34+
<p>TODO OptionException</p>
35+
<p>TODO HelpFormatter</p>
36+
</subsection>
37+
<subsection name="Querying the result">
38+
<p>TODO CommandLine</p>
39+
<p>TODO DefaultingCommandLine</p>
40+
</subsection>
41+
</section>
42+
</body>
43+
</document>

‎xdocs/manual/options.xml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<?xml version="1.0"?>
2+
<!--
3+
Copyright 2004 The Apache Software Foundation
4+
5+
Licensed under the Apache License, Version 2.0 (the "License");
6+
you may not use this file except in compliance with the License.
7+
You may obtain a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.
16+
-->
17+
<document>
18+
19+
<properties>
20+
<author email="commons-dev@jakarta.apache.org">commons-dev</author>
21+
<title>CLI2 - Options</title>
22+
</properties>
23+
24+
<body>
25+
<section name="Options">
26+
<img src="../images/options.jpg"/>
27+
<subsection name="Option">
28+
</subsection>
29+
<subsection name="Group">
30+
</subsection>
31+
<subsection name="Argument">
32+
</subsection>
33+
<subsection name="Parent">
34+
</subsection>
35+
<subsection name="DefaultOption">
36+
</subsection>
37+
<subsection name="Command">
38+
</subsection>
39+
<subsection name="Switch">
40+
</subsection>
41+
<subsection name="PropertyOption">
42+
</subsection>
43+
<subsection name="SourceDestArgument">
44+
</subsection>
45+
</section>
46+
</body>
47+
</document>

‎xdocs/manual/utilities.xml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<?xml version="1.0"?>
2+
<!--
3+
Copyright 2004 The Apache Software Foundation
4+
5+
Licensed under the Apache License, Version 2.0 (the "License");
6+
you may not use this file except in compliance with the License.
7+
You may obtain a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.
16+
-->
17+
<document>
18+
19+
<properties>
20+
<author email="commons-dev@jakarta.apache.org">commons-dev</author>
21+
<title>CLI2 - Utilities</title>
22+
</properties>
23+
24+
<body>
25+
<section name="Utilities">
26+
<img src="../images/utilities.jpg"/>
27+
<subsection name="HelpFormatter">
28+
</subsection>
29+
<subsection name="Comparators">
30+
</subsection>
31+
</section>
32+
<section name="Future Work">
33+
<p>TODO xml2cli</p>
34+
<p>TODO cli2ant</p>
35+
<p>TODO cli2html</p>
36+
</section>
37+
</body>
38+
</document>

‎xdocs/manual/validators.xml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<?xml version="1.0"?>
2+
<!--
3+
Copyright 2004 The Apache Software Foundation
4+
5+
Licensed under the Apache License, Version 2.0 (the "License");
6+
you may not use this file except in compliance with the License.
7+
You may obtain a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.
16+
-->
17+
<document>
18+
19+
<properties>
20+
<author email="commons-dev@jakarta.apache.org">commons-dev</author>
21+
<title>CLI2 - Validators</title>
22+
</properties>
23+
24+
<body>
25+
<section name="Validators">
26+
<img src="../images/validators.jpg"/>
27+
<subsection name="??">
28+
</subsection>
29+
</section>
30+
</body>
31+
</document>

0 commit comments

Comments
 (0)