commons-cli/xdocs/examples/index.xml at 38185db716f592471cff748fdbe9a34d4e65e4bb · Codegass/commons-cli · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
<?xml version="1.0"?>
<!--
 Copyright 2004 The Apache Software Foundation

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
-->
<document>

  <properties>
    <author email="commons-dev@jakarta.apache.org">commons-dev</author>
    <title>Examples</title>
  </properties>

  <body>
    <section name="Overview">
      <p>
        The examples section aims to show how a variety of applications and
        tools could be modelled using CLI2.  We make no claim that these tools
        use CLI2 in their implementation but simply use their interfaces to
        demonstrate commonly needed features.  Some examples will make
        simplifications to keep the documentation consise.
      </p>
      <p>
        Many aspects of the API are touched upon but few are described in
        great detail.  If more information is required then the reader is
        encouraged to review the API documentation and look at the unit tests
        for inspiration.  Failing that, further advice and discussion can be
        found on the <code>commons-user@jakarta.apache.org</code> mailing list.
      </p>
    </section>
  </body>
</document>