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 35b896a5 Move Properties documentation section to Javadoc
35b896a5 is described below
commit 35b896a5a7882943e1e3559dbb0dbc2fec1a5a6d
Author: Gary D. Gregory <[email protected]>
AuthorDate: Tue Jul 29 15:49:35 2025 -0400
Move Properties documentation section to Javadoc
---
src/main/javadoc/overview.html | 95 +++++++++++++++++++++++++++++++-
src/site/site.xml | 2 +-
src/site/xdoc/properties.xml | 122 -----------------------------------------
3 files changed, 95 insertions(+), 124 deletions(-)
diff --git a/src/main/javadoc/overview.html b/src/main/javadoc/overview.html
index c579fc60..40143cdf 100644
--- a/src/main/javadoc/overview.html
+++ b/src/main/javadoc/overview.html
@@ -650,5 +650,98 @@ public static void main(String[] args) {
Use '-count' instead</code></pre>
</section>
</section>
-
+ <section id="Properties">
+ <h1>Defining Option Properties</h1>
+ <p>
+ The following are the properties that each
+ <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="javadocs/api-release/org/apache/commons/cli/Option.Builder.html">Option.Builder</a>.
+ </p>
+ <table>
+ <caption>Option Properties</caption>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>arg</td>
+ <td>boolean</td>
+ <td>A flag to say whether the option takes an argument.</td>
+ </tr>
+ <tr>
+ <td>args</td>
+ <td>boolean</td>
+ <td>A flag to say whether the option takes more than one
argument.</td>
+ </tr>
+ <tr>
+ <td>argName</td>
+ <td>java.lang.String</td>
+ <td>The name of the argument value for the usage statement.</td>
+ </tr>
+ <tr>
+ <td>converter</td>
+ <td>org.apache.commons.cli.Converter<T, E extends
Throwable></td>
+ <td>A FunctionalInterface that converts a String to type T and may
throw an exception E. When
+ CommandLine.getParsedValue() is called this FunctionalInterface
will perform the conversion from the
+ command line argument to the parsed type. This is used when a
desired type is not registered, or to
+ provide a custom type implementation. The 'type' property is not
required to use the 'converter' property.</td>
+ </tr>
+ <tr>
+ <td>deprecated</td>
+ <td>org.apache.commons.cli.DeprecatedAttributes</td>
+ <td>Marks the option as deprecated and has the deprecation
properties.</td>
+ </tr>
+ <tr>
+ <td>description</td>
+ <td>java.lang.String</td>
+ <td>A description of the function of the option.</td>
+ </tr>
+ <tr>
+ <td>longOpt</td>
+ <td>java.lang.String</td>
+ <td>An alias and more descriptive identification string. May be null
or not specified if 'opt' is provided.</td>
+ </tr>
+ <tr>
+ <td>opt</td>
+ <td>java.lang.String</td>
+ <td>The identification string of the Option. May be null or not
specified if 'longOpt' is provided.</td>
+ </tr>
+ <tr>
+ <td>optionalArg</td>
+ <td>boolean</td>
+ <td>A flag to say whether the option's argument is optional.</td>
+ </tr>
+ <tr>
+ <td>required</td>
+ <td>boolean</td>
+ <td>A flag to say whether the option <b>must</b> appear on the
command line.</td>
+ </tr>
+ <tr>
+ <td>type</td>
+ <td>java.lang.Class<?></td>
+ <td>The class of the object returned from getParsedValue(). The
class must be registered in TypeHandler instance.
+ See also 'converter' property.</td>
+ </tr>
+ <tr>
+ <td>value</td>
+ <td>java.lang.String</td>
+ <td>The value of the option.</td>
+ </tr>
+ <tr>
+ <td>values</td>
+ <td>java.lang.String[]</td>
+ <td>The values of the option.</td>
+ </tr>
+ <tr>
+ <td>valueSeparator</td>
+ <td>char</td>
+ <td>The character value used to split the argument string, that is
used in conjunction with multipleArgs e.g.
+ if the separator is ',' and the argument string is 'a,b,c' then
there are three argument values, 'a', 'b'
+ and 'c'.</td>
+ </tr>
+ </table>
+ </section>
</body>
diff --git a/src/site/site.xml b/src/site/site.xml
index 6b8f7894..fb507740 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -47,7 +47,7 @@
<menu name="User Guide">
<item name="Getting started" href="/introduction.html"/>
<item name="Using CLI" href="/apidocs/index.html#Using"/>
- <item name="Option properties" href="/properties.html"/>
+ <item name="Option properties" href="/apidocs/index.html#Properties"/>
<item name="Javadoc" href="/apidocs/index.html"/>
<item name="Javadoc Archive"
href="https://javadoc.io/doc/commons-cli/commons-cli/latest/index.html"/>
</menu>
diff --git a/src/site/xdoc/properties.xml b/src/site/xdoc/properties.xml
deleted file mode 100644
index 7dfed6f4..00000000
--- a/src/site/xdoc/properties.xml
+++ /dev/null
@@ -1,122 +0,0 @@
-<?xml version="1.0"?>
-<!--
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you 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
-
- https://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 xmlns="http://maven.apache.org/XDOC/2.0";
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
- xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
- <properties>
- <title>Defining Option Properties</title>
- <author email="[email protected]">Apache Commons Team</author>
- </properties>
-
- <body>
- <section name="Defining Option Properties">
- <p>
- The following are the properties that each
- <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="javadocs/api-release/org/apache/commons/cli/Option.Builder.html">Option.Builder</a>.
- </p>
- <table>
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- </tr>
- <tr>
- <td>arg</td>
- <td>boolean</td>
- <td>A flag to say whether the option takes an argument.</td>
- </tr>
- <tr>
- <td>args</td>
- <td>boolean</td>
- <td>A flag to say whether the option takes more than one
argument.</td>
- </tr>
- <tr>
- <td>argName</td>
- <td>java.lang.String</td>
- <td>The name of the argument value for the usage statement.</td>
- </tr>
- <tr>
- <td>converter</td>
- <td>org.apache.commons.cli.Converter<T, E extends
Throwable></td>
- <td>A FunctionalInterface that converts a String to type T and may
throw an exception E. When
- CommandLine.getParsedValue() is called this FunctionalInterface
will perform the conversion from the
- command line argument to the parsed type. This is used when a
desired type is not registered, or to
- provide a custom type implementation. The 'type' property is not
required to use the 'converter' property.</td>
- </tr>
- <tr>
- <td>deprecated</td>
- <td>org.apache.commons.cli.DeprecatedAttributes</td>
- <td>Marks the option as deprecated and has the deprecation
properties.</td>
- </tr>
- <tr>
- <td>description</td>
- <td>java.lang.String</td>
- <td>A description of the function of the option.</td>
- </tr>
- <tr>
- <td>longOpt</td>
- <td>java.lang.String</td>
- <td>An alias and more descriptive identification string. May be null
or not specified if 'opt' is provided.</td>
- </tr>
- <tr>
- <td>opt</td>
- <td>java.lang.String</td>
- <td>The identification string of the Option. May be null or not
specified if 'longOpt' is provided.</td>
- </tr>
- <tr>
- <td>optionalArg</td>
- <td>boolean</td>
- <td>A flag to say whether the option's argument is optional.</td>
- </tr>
- <tr>
- <td>required</td>
- <td>boolean</td>
- <td>A flag to say whether the option <b>must</b> appear on the
command line.</td>
- </tr>
- <tr>
- <td>type</td>
- <td>java.lang.Class<?></td>
- <td>The class of the object returned from getParsedValue(). The
class must be registered in TypeHandler instance.
- See also 'converter' property.</td>
- </tr>
- <tr>
- <td>value</td>
- <td>java.lang.String</td>
- <td>The value of the option.</td>
- </tr>
- <tr>
- <td>values</td>
- <td>java.lang.String[]</td>
- <td>The values of the option.</td>
- </tr>
- <tr>
- <td>valueSeparator</td>
- <td>char</td>
- <td>The character value used to split the argument string, that is
used in conjunction with multipleArgs e.g.
- if the separator is ',' and the argument string is 'a,b,c' then
there are three argument values, 'a', 'b'
- and 'c'.</td>
- </tr>
- </table>
- </section>
- </body>
-</document>
