You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2024/05/28 16:18:22 UTC
(commons-cli) branch master updated: fix javadoc pathing (#280)
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-cli.git
The following commit(s) were added to refs/heads/master by this push:
new 6f70dfa fix javadoc pathing (#280)
6f70dfa is described below
commit 6f70dfa96016ff0cda64d97c97b9bf132e549805
Author: Eric Pugh <ep...@opensourceconnections.com>
AuthorDate: Tue May 28 12:18:11 2024 -0400
fix javadoc pathing (#280)
---
src/site/xdoc/properties.xml | 4 ++--
src/site/xdoc/usage.xml | 16 ++++++++--------
2 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/src/site/xdoc/properties.xml b/src/site/xdoc/properties.xml
index 9cd2e6b..6311243 100644
--- a/src/site/xdoc/properties.xml
+++ b/src/site/xdoc/properties.xml
@@ -28,10 +28,10 @@
<section name="Defining Option Properties">
<p>
The following are the properties that each
- <a href="api-release/org/apache/commons/cli/Option.html">Option</a> has. All of these
+ <a href="javadocs/api-release/org/apache/commons/cli/Option.html">Option</a> has. All of these
can be set using the accessors or using the methods
defined in the
- <a href="api-release/org/apache/commons/cli/OptionBuilder.html">OptionBuilder</a>.
+ <a href="javadocs/api-release/org/apache/commons/cli/OptionBuilder.html">OptionBuilder</a>.
</p>
<table>
<tr>
diff --git a/src/site/xdoc/usage.xml b/src/site/xdoc/usage.xml
index a8ec689..e736c02 100644
--- a/src/site/xdoc/usage.xml
+++ b/src/site/xdoc/usage.xml
@@ -45,7 +45,7 @@
</subsection>
<subsection name="Creating the Options">
<p>
- An <a href="api-release/org/apache/commons/cli/Options.html">
+ An <a href="javadocs/api-release/org/apache/commons/cli/Options.html">
Options</a> object must be created and the <code>Option</code> must be
added to it.
</p>
@@ -78,7 +78,7 @@ CommandLine cmd = parser.parse(options, args);</source>
<p>
Now we need to check if the <code>t</code> option is present. To do
this we will interrogate the
- <a href="api-release/org/apache/commons/cli/CommandLine.html">CommandLine
+ <a href="javadocs/api-release/org/apache/commons/cli/CommandLine.html">CommandLine
</a> object. The <code>hasOption</code> method takes a
<code>java.lang.String</code> parameter and returns <code>true</code> if the option
represented by the <code>java.lang.String</code> is present, otherwise
@@ -229,11 +229,11 @@ Option find = Option.builder("find")
<subsection name="Creating the Options">
<p>
Now that we have created each
- <a href="api-release/org/apache/commons/cli/Option.html">Option</a> we need
+ <a href="javadocs/api-release/org/apache/commons/cli/Option.html">Option</a> we need
to create the
- <a href="api-release/org/apache/commons/cli/Options.html">Options</a>
+ <a href="javadocs/api-release/org/apache/commons/cli/Options.html">Options</a>
instance. This is achieved using the
- <a href="api-release/org/apache/commons/cli/CommandLine.html#addOption(org.apache.commons.cli.Option)">addOption</a>
+ <a href="javadocs/api-release/org/apache/commons/cli/CommandLine.html#addOption(org.apache.commons.cli.Option)">addOption</a>
method of <code>Options</code>.
</p>
<source>Options options = new Options();
@@ -260,7 +260,7 @@ options.addOption(property);</source>
<p>
We now need to create a <code>CommandLineParser</code>. This will parse the command
line arguments, using the rules specified by the <code>Options</code> and
- return an instance of <a href="api-release/org/apache/commons/cli/CommandLine.html">CommandLine</a>.
+ return an instance of <a href="javadocs/api-release/org/apache/commons/cli/CommandLine.html">CommandLine</a>.
</p>
<source>public static void main(String[] args) {
// create the parser
@@ -291,7 +291,7 @@ if (line.hasOption("buildfile")) {
<p>
CLI also provides the means to automatically generate usage
and help information. This is achieved with the
- <a href="api-release/org/apache/commons/cli/HelpFormatter.html">HelpFormatter</a>
+ <a href="javadocs/api-release/org/apache/commons/cli/HelpFormatter.html">HelpFormatter</a>
class.
</p>
<source>// automatically generate the help statement
@@ -345,7 +345,7 @@ Sort entries alphabetically if none of -cftuSUX nor --sort.
-C list entries by columns</source>
<p>
The following is the code that is used to create the
- <a href="api-release/org/apache/commons/cli/Options.html">Options</a> for this example.
+ <a href="javadocs/api-release/org/apache/commons/cli/Options.html">Options</a> for this example.
</p>
<source>// create the command line parser
CommandLineParser parser = new DefaultParser();