Skip to content

Commit 1669210

Browse files
committed
Use oak leaf logo
1 parent 99682bc commit 1669210

File tree

3 files changed

+64
-9
lines changed

3 files changed

+64
-9
lines changed
Lines changed: 45 additions & 0 deletions
Loading
9.02 KB
Loading

src/main/javadoc/overview.html

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,12 @@
1919
<title>Apache Commons CLI Overview</title>
2020
</head>
2121
<body>
22-
<img src="../images/commons-logo.png" alt="Apache Commons CLI">
22+
<a href="https://commons.apache.org/cli"> <img src="org/apache/commons/cli/doc-files/logo.png" alt="Apache Commons CLI">
23+
</a>
24+
<section id="Introducing">
25+
<h1>
26+
<img src="org/apache/commons/cli/doc-files//leaf.svg" style="height: 1em; padding-right: 0.25em" alt="leaf" />Introducing Apache Commons CLI
27+
</h1>
2328

2429
<p>The Apacahe Commons CLI component parses command-line arguments for your application.</p>
2530

@@ -40,8 +45,6 @@
4045
<p>
4146
The homepage for the project is <a href="https://commons.apache.org">Apache Commons</a>
4247
</p>
43-
<section id="Introducing">
44-
<h1>Introducing Apache Commons CLI</h1>
4548
<p>
4649
There are three stages to command line processing. They are the
4750
definition, parsing and interrogation stages. The following
@@ -117,7 +120,7 @@ <h2>Interrogating the CLI</h2>
117120
</section>
118121
</section>
119122
<section id="Using">
120-
<h1>Using Apache Commons CLI</h1>
123+
<h1><img src="org/apache/commons/cli/doc-files//leaf.svg" style="height: 1em; padding-right: 0.25em" alt="leaf" />Using Apache Commons CLI</h1>
121124
<p>
122125
The following sections describe some example scenarios on how to
123126
use CLI in applications.
@@ -240,7 +243,7 @@ <h2>Retrieving the argument value</h2>
240243
</section>
241244

242245
<section>
243-
<h1>Using Ant as an Example</h1>
246+
<h1><img src="org/apache/commons/cli/doc-files//leaf.svg" style="height: 1em; padding-right: 0.25em" alt="leaf" />Using Ant as an Example</h1>
244247
<p>
245248
<a href="https://ant.apache.org/">Ant</a> will be used
246249
here to illustrate how to create the <code>Options</code> required. The following
@@ -431,7 +434,7 @@ <h2>Displaying Usage and Help</h2>
431434
</section>
432435

433436
<section>
434-
<h1>Creating an ls Example</h1>
437+
<h1><img src="org/apache/commons/cli/doc-files//leaf.svg" style="height: 1em; padding-right: 0.25em" alt="leaf" />Creating an ls Example</h1>
435438
<p>
436439
One of the most widely used command line applications in the *nix world
437440
is <code>ls</code>. Due to the large number of options required for <code>ls</code>
@@ -494,7 +497,7 @@ <h1>Creating an ls Example</h1>
494497
} </code></pre>
495498
</section>
496499
<section>
497-
<h1>Converting (Parsing) Option Values</h1>
500+
<h1><img src="org/apache/commons/cli/doc-files//leaf.svg" style="height: 1em; padding-right: 0.25em" alt="leaf" />Converting (Parsing) Option Values</h1>
498501
<p>
499502
By in most cases the values on the command line are retrieved as Strings via the
500503
<code>commandLine.getOptionValue(key)</code> command. However, it is possible for
@@ -572,7 +575,7 @@ <h1>Converting (Parsing) Option Values</h1>
572575
</p>
573576
</section>
574577
<section>
575-
<h1>Deprecating Options</h1>
578+
<h1><img src="org/apache/commons/cli/doc-files//leaf.svg" style="height: 1em; padding-right: 0.25em" alt="leaf" />Deprecating Options</h1>
576579
<p>
577580
Options may be marked as deprecated using ghe <code>Option.builder.deprecated()</code> method.
578581
Additional information may be specified by passing a <code>DeprecatedAttributes</code> instance to the
@@ -726,7 +729,7 @@ <h2>Changing help format</h2>
726729
</section>
727730
</section>
728731
<section id="Properties">
729-
<h1>Defining Option Properties</h1>
732+
<h1><img src="org/apache/commons/cli/doc-files//leaf.svg" style="height: 1em; padding-right: 0.25em" alt="leaf" />Defining Option Properties</h1>
730733
<p>
731734
The following are the properties that each
732735
<a href="javadocs/api-release/org/apache/commons/cli/Option.html">Option</a> has. All of these
@@ -819,4 +822,11 @@ <h1>Defining Option Properties</h1>
819822
</tr>
820823
</table>
821824
</section>
825+
<h1>
826+
<img src="org/apache/commons/cli/doc-files/leaf.svg" style="height: 1em; padding-right: 0.25em" alt="leaf">Requirements
827+
</h1>
828+
<ul>
829+
<li>Java 8 or above.</li>
830+
<li>If using OSGi, R7 or above.</li>
831+
</ul>
822832
</body>

0 commit comments

Comments
 (0)