This is an automated email from the ASF dual-hosted git repository.
garydgregory 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 5b2558e0 Javadoc
5b2558e0 is described below
commit 5b2558e0149d2f27906026808d42126f28a08826
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 11:21:45 2026 -0400
Javadoc
---
.../commons/cli/AlreadySelectedException.java | 6 +-
.../commons/cli/AmbiguousOptionException.java | 4 +-
.../java/org/apache/commons/cli/CommandLine.java | 132 ++++++++++-----------
.../org/apache/commons/cli/CommandLineParser.java | 8 +-
.../java/org/apache/commons/cli/Converter.java | 2 +-
.../java/org/apache/commons/cli/DefaultParser.java | 34 +++---
.../apache/commons/cli/DeprecatedAttributes.java | 4 +-
.../java/org/apache/commons/cli/HelpFormatter.java | 118 +++++++++---------
.../commons/cli/MissingArgumentException.java | 4 +-
.../apache/commons/cli/MissingOptionException.java | 6 +-
src/main/java/org/apache/commons/cli/Option.java | 32 ++---
.../java/org/apache/commons/cli/OptionBuilder.java | 18 +--
.../java/org/apache/commons/cli/OptionGroup.java | 4 +-
.../org/apache/commons/cli/OptionValidator.java | 8 +-
src/main/java/org/apache/commons/cli/Options.java | 10 +-
.../org/apache/commons/cli/ParseException.java | 6 +-
src/main/java/org/apache/commons/cli/Parser.java | 20 ++--
.../apache/commons/cli/PatternOptionBuilder.java | 8 +-
.../java/org/apache/commons/cli/TypeHandler.java | 28 ++---
.../commons/cli/UnrecognizedOptionException.java | 6 +-
src/main/java/org/apache/commons/cli/Util.java | 2 +-
.../commons/cli/help/AbstractHelpFormatter.java | 44 +++----
.../commons/cli/help/FilterHelpAppendable.java | 2 +-
.../apache/commons/cli/help/HelpAppendable.java | 12 +-
.../org/apache/commons/cli/help/HelpFormatter.java | 6 +-
.../apache/commons/cli/help/OptionFormatter.java | 26 ++--
.../apache/commons/cli/help/TableDefinition.java | 6 +-
.../commons/cli/help/TextHelpAppendable.java | 32 ++---
.../org/apache/commons/cli/help/TextStyle.java | 12 +-
.../java/org/apache/commons/cli/help/Util.java | 10 +-
.../org/apache/commons/cli/CommandLineTest.java | 44 +++----
.../commons/cli/example/AptHelpAppendable.java | 2 +-
.../commons/cli/example/XhtmlHelpAppendable.java | 2 +-
33 files changed, 329 insertions(+), 329 deletions(-)
diff --git a/src/main/java/org/apache/commons/cli/AlreadySelectedException.java
b/src/main/java/org/apache/commons/cli/AlreadySelectedException.java
index 1bcbf6f0..99024c19 100644
--- a/src/main/java/org/apache/commons/cli/AlreadySelectedException.java
+++ b/src/main/java/org/apache/commons/cli/AlreadySelectedException.java
@@ -36,8 +36,8 @@ public class AlreadySelectedException extends ParseException {
/**
* Constructs a new {@code AlreadySelectedException} for the specified
option group.
*
- * @param optionGroup the option group already selected.
- * @param option the option that triggered the exception.
+ * @param optionGroup The option group already selected.
+ * @param option The option that triggered the exception.
* @since 1.2
*/
public AlreadySelectedException(final OptionGroup optionGroup, final
Option option) {
@@ -48,7 +48,7 @@ public class AlreadySelectedException extends ParseException {
/**
* Constructs a new {@code AlreadySelectedException} with the specified
detail message.
*
- * @param message the detail message.
+ * @param message The detail message.
*/
public AlreadySelectedException(final String message) {
this(message, null, null);
diff --git a/src/main/java/org/apache/commons/cli/AmbiguousOptionException.java
b/src/main/java/org/apache/commons/cli/AmbiguousOptionException.java
index 08ed4e5c..1a64e95c 100644
--- a/src/main/java/org/apache/commons/cli/AmbiguousOptionException.java
+++ b/src/main/java/org/apache/commons/cli/AmbiguousOptionException.java
@@ -62,8 +62,8 @@ public class AmbiguousOptionException extends
UnrecognizedOptionException {
/**
* Constructs a new AmbiguousOptionException.
*
- * @param option the partial option name.
- * @param matchingOptions the options matching the name.
+ * @param option The partial option name.
+ * @param matchingOptions The options matching the name.
*/
public AmbiguousOptionException(final String option, final
Collection<String> matchingOptions) {
super(createMessage(option, matchingOptions), option);
diff --git a/src/main/java/org/apache/commons/cli/CommandLine.java
b/src/main/java/org/apache/commons/cli/CommandLine.java
index f62ab89b..2942d5f9 100644
--- a/src/main/java/org/apache/commons/cli/CommandLine.java
+++ b/src/main/java/org/apache/commons/cli/CommandLine.java
@@ -76,7 +76,7 @@ public class CommandLine implements Serializable {
/**
* Adds left-over unrecognized option/argument.
*
- * @param arg the unrecognized option/argument.
+ * @param arg The unrecognized option/argument.
* @return this Builder instance for method chaining.
*/
public Builder addArg(final String arg) {
@@ -89,7 +89,7 @@ public class CommandLine implements Serializable {
/**
* Adds an option to the command line. The values of the option are
stored.
*
- * @param option the processed option.
+ * @param option The processed option.
* @return this Builder instance for method chaining.
*/
public Builder addOption(final Option option) {
@@ -124,7 +124,7 @@ public class CommandLine implements Serializable {
/**
* Sets the deprecated option handler.
*
- * @param deprecatedHandler the deprecated option handler.
+ * @param deprecatedHandler The deprecated option handler.
* @return {@code this} instance.
* @since 1.7.0
*/
@@ -180,7 +180,7 @@ public class CommandLine implements Serializable {
/**
* Adds left-over unrecognized option/argument.
*
- * @param arg the unrecognized option/argument.
+ * @param arg The unrecognized option/argument.
*/
protected void addArg(final String arg) {
if (arg != null) {
@@ -191,7 +191,7 @@ public class CommandLine implements Serializable {
/**
* Adds an option to the command line. The values of the option are stored.
*
- * @param option the processed option.
+ * @param option The processed option.
*/
protected void addOption(final Option option) {
if (option != null) {
@@ -202,7 +202,7 @@ public class CommandLine implements Serializable {
/**
* Gets the first element or null if values is null.
*
- * @param values the array to query.
+ * @param values The array to query.
* @return The first element or null if values is null.
*/
private String first(final String[] values) {
@@ -234,7 +234,7 @@ public class CommandLine implements Serializable {
/**
* Gets the number of times this option appears in the command line
*
- * @param optionChar the character name of the option.
+ * @param optionChar The character name of the option.
* @return Number of times the option is present.
* @since 1.11.0
*/
@@ -245,7 +245,7 @@ public class CommandLine implements Serializable {
/**
* Gets the number of times this option appears in the command line.
*
- * @param option the option.
+ * @param option The option.
* @return Number of times the option is present.
* @since 1.11.0
*/
@@ -256,7 +256,7 @@ public class CommandLine implements Serializable {
/**
* Gets the number of times this option appears in the command line
*
- * @param optionName the name of the option.
+ * @param optionName The name of the option.
* @return Number of times the option is present.
* @since 1.11.0
*/
@@ -267,7 +267,7 @@ public class CommandLine implements Serializable {
/**
* Gets the {@code Object} type of this {@code Option}.
*
- * @param optionChar the name of the option.
+ * @param optionChar The name of the option.
* @return The type of opt.
* @deprecated due to System.err message; use {@link
#getParsedOptionValue(char)} instead.
*/
@@ -279,7 +279,7 @@ public class CommandLine implements Serializable {
/**
* Gets the {@code Object} type of this {@code Option}.
*
- * @param optionName the name of the option.
+ * @param optionName The name of the option.
* @return The type of this {@code Option}.
* @deprecated due to System.err message; use {@link
#getParsedOptionValue(String)} instead.
*/
@@ -346,7 +346,7 @@ public class CommandLine implements Serializable {
/**
* Gets the first argument, if any, of this option.
*
- * @param optionChar the character name of the option.
+ * @param optionChar The character name of the option.
* @return Value of the argument if option is set, and has an argument,
otherwise null.
*/
public String getOptionValue(final char optionChar) {
@@ -379,7 +379,7 @@ public class CommandLine implements Serializable {
/**
* Gets the first argument, if any, of this option.
*
- * @param option the option.
+ * @param option The option.
* @return Value of the argument if option is set, and has an argument,
otherwise null.
* @since 1.5.0
*/
@@ -390,7 +390,7 @@ public class CommandLine implements Serializable {
/**
* Gets the first argument, if any, of an option.
*
- * @param option the option.
+ * @param option The option.
* @param defaultValue is the default value to be returned if the option
is not specified.
* @return Value of the argument if option is set, and has an argument,
otherwise {@code defaultValue}.
* @since 1.5.0
@@ -402,7 +402,7 @@ public class CommandLine implements Serializable {
/**
* Gets the first argument, if any, of an option.
*
- * @param option the option.
+ * @param option The option.
* @param defaultValue is a supplier for the default value to be returned
if the option is not specified.
* @return Value of the argument if option is set, and has an argument,
otherwise {@code defaultValue}.
* @since 1.7.0
@@ -415,7 +415,7 @@ public class CommandLine implements Serializable {
/**
* Gets the first argument, if any, of this option group.
*
- * @param optionGroup the option group.
+ * @param optionGroup The option group.
* @return Value of the argument if option group is selected, and has an
argument, otherwise null.
* @since 1.9.0
*/
@@ -426,7 +426,7 @@ public class CommandLine implements Serializable {
/**
* Gets the first argument, if any, of an option group.
*
- * @param optionGroup the option group.
+ * @param optionGroup The option group.
* @param defaultValue is the default value to be returned if the option
group is not selected.
* @return Value of the argument if option group is selected, and has an
argument, otherwise {@code defaultValue}.
* @since 1.9.0
@@ -438,7 +438,7 @@ public class CommandLine implements Serializable {
/**
* Gets the first argument, if any, of an option group.
*
- * @param optionGroup the option group.
+ * @param optionGroup The option group.
* @param defaultValue is a supplier for the default value to be returned
if the option group is not selected.
* @return Value of the argument if option group is selected, and has an
argument, otherwise {@code defaultValue}.
* @since 1.9.0
@@ -451,7 +451,7 @@ public class CommandLine implements Serializable {
/**
* Gets the first argument, if any, of this option.
*
- * @param optionName the name of the option.
+ * @param optionName The name of the option.
* @return Value of the argument if option is set, and has an argument,
otherwise null.
*/
public String getOptionValue(final String optionName) {
@@ -494,7 +494,7 @@ public class CommandLine implements Serializable {
/**
* Gets the array of values, if any, of an option.
*
- * @param option the option.
+ * @param option The option.
* @return Values of the argument if option is set, and has an argument,
otherwise null.
* @since 1.5.0
*/
@@ -517,7 +517,7 @@ public class CommandLine implements Serializable {
/**
* Gets the array of values, if any, of an option group.
*
- * @param optionGroup the option group.
+ * @param optionGroup The option group.
* @return Values of the argument if option group is selected, and has an
argument, otherwise null.
* @since 1.9.0
*/
@@ -541,7 +541,7 @@ public class CommandLine implements Serializable {
/**
* Gets a version of this {@code Option} converted to a particular type.
*
- * @param optionChar the name of the option.
+ * @param optionChar The name of the option.
* @param <T> The return type for the method.
* @return The value parsed into a particular object or null if the option
is not set.
* @throws ParseException if there are problems turning the option value
into the desired type.
@@ -555,8 +555,8 @@ public class CommandLine implements Serializable {
/**
* Gets a version of this {@code Option} converted to a particular type.
*
- * @param optionChar the name of the option.
- * @param defaultValue the default value to return if opt is not set.
+ * @param optionChar The name of the option.
+ * @param defaultValue The default value to return if opt is not set.
* @param <T> The return type for the method.
* @return The value parsed into a particular object or the defaultValue
if the option is not set.
* @throws ParseException if there are problems turning the option value
into the desired type.
@@ -570,8 +570,8 @@ public class CommandLine implements Serializable {
/**
* Gets a version of this {@code Option} converted to a particular type.
*
- * @param optionChar the name of the option.
- * @param defaultValue the default value to return if opt is not set.
+ * @param optionChar The name of the option.
+ * @param defaultValue The default value to return if opt is not set.
* @param <T> The return type for the method.
* @return The value parsed into a particular object or the defaultValue
if the option is not set.
* @throws ParseException if there are problems turning the option value
into the desired type.
@@ -585,7 +585,7 @@ public class CommandLine implements Serializable {
/**
* Gets a version of this {@code Option} converted to a particular type.
*
- * @param option the option.
+ * @param option The option.
* @param <T> The return type for the method.
* @return The value parsed into a particular object or null if the option
is not set.
* @throws ParseException if there are problems turning the option value
into the desired type.
@@ -599,8 +599,8 @@ public class CommandLine implements Serializable {
/**
* Gets a version of this {@code Option} converted to a particular type.
*
- * @param option the option.
- * @param defaultValue the default value to return if opt is not set.
+ * @param option The option.
+ * @param defaultValue The default value to return if opt is not set.
* @param <T> The return type for the method.
* @return The value parsed into a particular object or the defaultValue
if the option is not set.
* @throws ParseException if there are problems turning the option value
into the desired type.
@@ -626,8 +626,8 @@ public class CommandLine implements Serializable {
/**
* Gets a version of this {@code Option} converted to a particular type.
*
- * @param option the option.
- * @param defaultValue the default value to return if opt is not set.
+ * @param option The option.
+ * @param defaultValue The default value to return if opt is not set.
* @param <T> The return type for the method.
* @return The value parsed into a particular object or the defaultValue
if the option is not set.
* @throws ParseException if there are problems turning the option value
into the desired type.
@@ -641,7 +641,7 @@ public class CommandLine implements Serializable {
/**
* Gets a version of this {@code OptionGroup} converted to a particular
type.
*
- * @param optionGroup the option group.
+ * @param optionGroup The option group.
* @param <T> The return type for the method.
* @return The value parsed into a particular object or null if no option
in the OptionGroup is set.
* @throws ParseException if there are problems turning the selected
option value into the desired type.
@@ -655,8 +655,8 @@ public class CommandLine implements Serializable {
/**
* Gets a version of this {@code OptionGroup} converted to a particular
type.
*
- * @param optionGroup the option group.
- * @param defaultValue the default value to return if opt is not set.
+ * @param optionGroup The option group.
+ * @param defaultValue The default value to return if opt is not set.
* @param <T> The return type for the method.
* @return The value parsed into a particular object or the defaultValue
if no option in the OptionGroup is set.
* @throws ParseException if there are problems turning the selected
option value into the desired type.
@@ -673,8 +673,8 @@ public class CommandLine implements Serializable {
/**
* Gets a version of this {@code OptionGroup} converted to a particular
type.
*
- * @param optionGroup the option group.
- * @param defaultValue the default value to return if an option is not
selected.
+ * @param optionGroup The option group.
+ * @param defaultValue The default value to return if an option is not
selected.
* @param <T> The return type for the method.
* @return The value parsed into a particular object or the defaultValue
if no option in the OptionGroup is set.
* @throws ParseException if there are problems turning the option value
into the desired type.
@@ -688,7 +688,7 @@ public class CommandLine implements Serializable {
/**
* Gets a version of this {@code Option} converted to a particular type.
*
- * @param optionName the name of the option.
+ * @param optionName The name of the option.
* @param <T> The return type for the method.
* @return The value parsed into a particular object or null if the option
is not set.
* @throws ParseException if there are problems turning the option value
into the desired type.
@@ -702,8 +702,8 @@ public class CommandLine implements Serializable {
/**
* Gets a version of this {@code Option} converted to a particular type.
*
- * @param optionName the name of the option.
- * @param defaultValue the default value to return if opt is not set.
+ * @param optionName The name of the option.
+ * @param defaultValue The default value to return if opt is not set.
* @param <T> The return type for the method.
* @return The value parsed into a particular object or the defaultValue
if the option is not set.
* @throws ParseException if there are problems turning the option value
into the desired type.
@@ -717,8 +717,8 @@ public class CommandLine implements Serializable {
/**
* Gets a version of this {@code Option} converted to a particular type.
*
- * @param optionName the name of the option.
- * @param defaultValue the default value to return if opt is not set.
+ * @param optionName The name of the option.
+ * @param defaultValue The default value to return if opt is not set.
* @param <T> The return type for the method.
* @return The value parsed into a particular object or the defaultValue
if the option is not set.
* @throws ParseException if there are problems turning the option value
into the desired type.
@@ -732,7 +732,7 @@ public class CommandLine implements Serializable {
/**
* Gets a version of this {@code Option} converted to an array of a
particular type.
*
- * @param optionChar the name of the option.
+ * @param optionChar The name of the option.
* @param <T> The array type for the return value.
* @return The values parsed into an array of objects or null if the
option is not set.
* @throws ParseException if there are problems turning the option value
into the desired type.
@@ -746,8 +746,8 @@ public class CommandLine implements Serializable {
/**
* Gets a version of this {@code Option} converted to an array of a
particular type.
*
- * @param optionChar the name of the option.
- * @param defaultValue the default value to return if opt is not set.
+ * @param optionChar The name of the option.
+ * @param defaultValue The default value to return if opt is not set.
* @param <T> The array type for the return value.
* @return The values parsed into an array of objects or the defaultValue
if the option is not set.
* @throws ParseException if there are problems turning the option value
into the desired type.
@@ -761,8 +761,8 @@ public class CommandLine implements Serializable {
/**
* Gets a version of this {@code Option} converted to an array of a
particular type.
*
- * @param optionChar the name of the option.
- * @param defaultValue the default value to return if opt is not set.
+ * @param optionChar The name of the option.
+ * @param defaultValue The default value to return if opt is not set.
* @param <T> The array type for the return value.
* @return The values parsed into an array of objects or the defaultValue
if the option is not set.
* @throws ParseException if there are problems turning the option value
into the desired type.
@@ -776,7 +776,7 @@ public class CommandLine implements Serializable {
/**
* Gets a version of this {@code Option} converted to an array of a
particular type.
*
- * @param option the option.
+ * @param option The option.
* @param <T> The array type for the return value.
* @return The values parsed into an array of objects or null if the
option is not set.
* @throws ParseException if there are problems turning the option value
into the desired type.
@@ -790,8 +790,8 @@ public class CommandLine implements Serializable {
/**
* Gets a version of this {@code Option} converted to an array of a
particular type.
*
- * @param option the option.
- * @param defaultValue the default value to return if opt is not set.
+ * @param option The option.
+ * @param defaultValue The default value to return if opt is not set.
* @param <T> The array type for the return value.
* @return The values parsed into an array of objects or the defaultValue
if the option is not set.
* @throws ParseException if there are problems turning the option value
into the desired type.
@@ -822,8 +822,8 @@ public class CommandLine implements Serializable {
/**
* Gets a version of this {@code Option} converted to an array of a
particular type.
*
- * @param option the option.
- * @param defaultValue the default value to return if opt is not set.
+ * @param option The option.
+ * @param defaultValue The default value to return if opt is not set.
* @param <T> The array type for the return value.
* @return The values parsed into an array of objects or the defaultValue
if the option is not set.
* @throws ParseException if there are problems turning the option value
into the desired type.
@@ -837,7 +837,7 @@ public class CommandLine implements Serializable {
/**
* Gets a version of this {@code OptionGroup} converted to an array of a
particular type.
*
- * @param optionGroup the option group.
+ * @param optionGroup The option group.
* @param <T> The array type for the return value.
* @return The values parsed into an array of objects or null if no option
in the OptionGroup is set.
* @throws ParseException if there are problems turning the selected
option value into the desired type.
@@ -851,8 +851,8 @@ public class CommandLine implements Serializable {
/**
* Gets a version of this {@code OptionGroup} converted to an array of a
particular type.
*
- * @param optionGroup the option group.
- * @param defaultValue the default value to return if opt is not set.
+ * @param optionGroup The option group.
+ * @param defaultValue The default value to return if opt is not set.
* @param <T> The array type for the return value.
* @return The values parsed into an array of objects or null if no option
in the OptionGroup is set.
* @throws ParseException if there are problems turning the selected
option value into the desired type.
@@ -869,8 +869,8 @@ public class CommandLine implements Serializable {
/**
* Gets a version of this {@code OptionGroup} converted to an array of a
particular type.
*
- * @param optionGroup the option group.
- * @param defaultValue the default value to return if an option is not
selected.
+ * @param optionGroup The option group.
+ * @param defaultValue The default value to return if an option is not
selected.
* @param <T> The array type for the return value.
* @return The values parsed into an array of objects or null if no option
in the OptionGroup is set.
* @throws ParseException if there are problems turning the option value
into the desired type.
@@ -884,7 +884,7 @@ public class CommandLine implements Serializable {
/**
* Gets a version of this {@code Option} converted to an array of a
particular type.
*
- * @param optionName the name of the option.
+ * @param optionName The name of the option.
* @param <T> The array type for the return value.
* @return The values parsed into an array of objects or null if the
option is not set.
* @throws ParseException if there are problems turning the option value
into the desired type.
@@ -898,8 +898,8 @@ public class CommandLine implements Serializable {
/**
* Gets a version of this {@code Option} converted to an array of a
particular type.
*
- * @param optionName the name of the option.
- * @param defaultValue the default value to return if opt is not set.
+ * @param optionName The name of the option.
+ * @param defaultValue The default value to return if opt is not set.
* @param <T> The array type for the return value.
* @return The values parsed into an array of objects or defaultValues if
the option is not set.
* @throws ParseException if there are problems turning the option value
into the desired type.
@@ -913,8 +913,8 @@ public class CommandLine implements Serializable {
/**
* Gets a version of this {@code Option} converted to an array of a
particular type.
*
- * @param optionName the name of the option.
- * @param defaultValue the default value to return if opt is not set.
+ * @param optionName The name of the option.
+ * @param defaultValue The default value to return if opt is not set.
* @param <T> The array type for the return value.
* @return The values parsed into an array of objects or defaultValues if
the option is not set.
* @throws ParseException if there are problems turning the option value
into the desired type.
@@ -928,7 +928,7 @@ public class CommandLine implements Serializable {
/**
* Handles deprecated options.
*
- * @param option a deprecated option.
+ * @param option A deprecated option.
*/
private void handleDeprecated(final Option option) {
if (deprecatedHandler != null) {
@@ -967,7 +967,7 @@ public class CommandLine implements Serializable {
/**
* Tests to see if an option has been set.
*
- * @param option the option to check.
+ * @param option The option to check.
* @return true if set, false if not.
* @since 1.5.0
*/
@@ -982,7 +982,7 @@ public class CommandLine implements Serializable {
/**
* Tests to see if an option has been set.
*
- * @param optionGroup the option group to check.
+ * @param optionGroup The option group to check.
* @return true if set, false if not.
* @since 1.9.0
*/
@@ -1017,8 +1017,8 @@ public class CommandLine implements Serializable {
* and even numbered values are property values. If there are an odd
number of values
* the last value is assumed to be a boolean with a value of "true".
*
- * @param props the properties to update.
- * @param values the list of values to parse.
+ * @param props The properties to update.
+ * @param values The list of values to parse.
*/
private void processPropertiesFromValues(final Properties props, final
List<String> values) {
for (int i = 0; i < values.size(); i += 2) {
diff --git a/src/main/java/org/apache/commons/cli/CommandLineParser.java
b/src/main/java/org/apache/commons/cli/CommandLineParser.java
index 125597a5..8b686905 100644
--- a/src/main/java/org/apache/commons/cli/CommandLineParser.java
+++ b/src/main/java/org/apache/commons/cli/CommandLineParser.java
@@ -26,8 +26,8 @@ public interface CommandLineParser {
/**
* Parses the arguments according to the specified options.
*
- * @param options the specified Options.
- * @param arguments the command line arguments.
+ * @param options The specified Options.
+ * @param arguments The command line arguments.
* @return The list of atomic option and value tokens.
* @throws ParseException if there are any problems encountered while
parsing the command line tokens.
*/
@@ -36,8 +36,8 @@ public interface CommandLineParser {
/**
* Parses the arguments according to the specified options.
*
- * @param options the specified Options.
- * @param arguments the command line arguments.
+ * @param options The specified Options.
+ * @param arguments The command line arguments.
* @param stopAtNonOption if {@code true} an unrecognized argument stops
the parsing and the remaining arguments
* are added to the {@link CommandLine}s args list. If {@code
false} an unrecognized argument triggers a
* ParseException.
diff --git a/src/main/java/org/apache/commons/cli/Converter.java
b/src/main/java/org/apache/commons/cli/Converter.java
index 844d485b..a984ad04 100644
--- a/src/main/java/org/apache/commons/cli/Converter.java
+++ b/src/main/java/org/apache/commons/cli/Converter.java
@@ -91,7 +91,7 @@ public interface Converter<T, E extends Exception> {
/**
* Applies the conversion function to the String argument.
*
- * @param string the String to convert.
+ * @param string The String to convert.
* @return The Object from the conversion.
* @throws E on error.
*/
diff --git a/src/main/java/org/apache/commons/cli/DefaultParser.java
b/src/main/java/org/apache/commons/cli/DefaultParser.java
index e1910ccf..9f9285d7 100644
--- a/src/main/java/org/apache/commons/cli/DefaultParser.java
+++ b/src/main/java/org/apache/commons/cli/DefaultParser.java
@@ -125,7 +125,7 @@ public class DefaultParser implements CommandLineParser {
/**
* Sets the deprecated option handler.
*
- * @param deprecatedHandler the deprecated option handler.
+ * @param deprecatedHandler The deprecated option handler.
* @return {@code this} instance.
* @since 1.7.0
*/
@@ -318,7 +318,7 @@ public class DefaultParser implements CommandLineParser {
/**
* Adds token to command line {@link CommandLine#addArg(String)}.
*
- * @param token the unrecognized option/argument.
+ * @param token The unrecognized option/argument.
* @since 1.10.0
*/
protected void addArg(final String token) {
@@ -371,7 +371,7 @@ public class DefaultParser implements CommandLineParser {
/**
* Gets a list of matching option strings for the given token, depending
on the selected partial matching policy.
*
- * @param token the token (may contain leading dashes).
+ * @param token The token (may contain leading dashes).
* @return The list of matching option strings or an empty list if no
matching option could be found.
*/
private List<String> getMatchingLongOptions(final String token) {
@@ -427,7 +427,7 @@ public class DefaultParser implements CommandLineParser {
* --L --L=V --L V --l
* </pre>
*
- * @param token the command line token to handle.
+ * @param token The command line token to handle.
*/
private void handleLongOption(final String token) throws ParseException {
if (indexOfEqual(token) == -1) {
@@ -443,7 +443,7 @@ public class DefaultParser implements CommandLineParser {
* --L=V -L=V --l=V -l=V
* </pre>
*
- * @param token the command line token to handle.
+ * @param token The command line token to handle.
*/
private void handleLongOptionWithEqual(final String token) throws
ParseException {
final int pos = indexOfEqual(token);
@@ -474,7 +474,7 @@ public class DefaultParser implements CommandLineParser {
* --L -L --l -l
* </pre>
*
- * @param token the command line token to handle.
+ * @param token The command line token to handle.
*/
private void handleLongOptionWithoutEqual(final String token) throws
ParseException {
final List<String> matchingOpts = getMatchingLongOptions(token);
@@ -541,7 +541,7 @@ public class DefaultParser implements CommandLineParser {
* -L -LV -L V -L=V -l
* </pre>
*
- * @param hyphenToken the command line token to handle.
+ * @param hyphenToken The command line token to handle.
*/
private void handleShortAndLongOption(final String hyphenToken) throws
ParseException {
final String token = Util.stripLeadingHyphens(hyphenToken);
@@ -609,7 +609,7 @@ public class DefaultParser implements CommandLineParser {
/**
* Handles any command line token.
*
- * @param token the command line token to handle.
+ * @param token The command line token to handle.
* @throws ParseException
*/
private void handleToken(final String token) throws ParseException {
@@ -639,7 +639,7 @@ public class DefaultParser implements CommandLineParser {
* token is added to the arguments of the command line. If the
stopAtNonOption flag is set, this stops the parsing and
* the remaining tokens are added as-is in the arguments of the command
line.
*
- * @param token the command line token to handle.
+ * @param token The command line token to handle.
* @throws ParseException if parsing should fail.
* @since 1.10.0
*/
@@ -742,10 +742,10 @@ public class DefaultParser implements CommandLineParser {
/**
* Parses the arguments according to the specified options and properties.
*
- * @param options the specified Options
+ * @param options The specified Options
* @param properties command line option name-value pairs
* @param nonOptionAction see {@link NonOptionAction}.
- * @param arguments the command line arguments
+ * @param arguments The command line arguments
*
* @return The list of atomic option and value tokens.
* @throws ParseException if there are any problems encountered while
parsing the command line tokens.
@@ -792,8 +792,8 @@ public class DefaultParser implements CommandLineParser {
/**
* Parses the arguments according to the specified options and properties.
*
- * @param options the specified Options.
- * @param arguments the command line arguments.
+ * @param options The specified Options.
+ * @param arguments The command line arguments.
* @param properties command line option name-value pairs.
* @return The list of atomic option and value tokens.
* @throws ParseException if there are any problems encountered while
parsing the command line tokens.
@@ -805,8 +805,8 @@ public class DefaultParser implements CommandLineParser {
/**
* Parses the arguments according to the specified options and properties.
*
- * @param options the specified Options.
- * @param arguments the command line arguments.
+ * @param options The specified Options.
+ * @param arguments The command line arguments.
* @param properties command line option name-value pairs.
* @param stopAtNonOption if {@code true} an unrecognized argument stops
the parsing and the remaining arguments
* are added to the {@link CommandLine}s args list. If {@code
false} an unrecognized argument triggers a
@@ -824,7 +824,7 @@ public class DefaultParser implements CommandLineParser {
* Strips balanced leading and trailing quotes if the
stripLeadingAndTrailingQuotes is set
* If stripLeadingAndTrailingQuotes is null, then do not strip
*
- * @param token a string.
+ * @param token A string.
* @return token with the quotes stripped (if set).
*/
private String stripLeadingAndTrailingQuotesDefaultOff(final String token)
{
@@ -838,7 +838,7 @@ public class DefaultParser implements CommandLineParser {
* Strips balanced leading and trailing quotes if the
stripLeadingAndTrailingQuotes is set
* If stripLeadingAndTrailingQuotes is null, then do not strip
*
- * @param token a string.
+ * @param token A string.
* @return token with the quotes stripped (if set).
*/
private String stripLeadingAndTrailingQuotesDefaultOn(final String token) {
diff --git a/src/main/java/org/apache/commons/cli/DeprecatedAttributes.java
b/src/main/java/org/apache/commons/cli/DeprecatedAttributes.java
index 78830c00..3d19a2b7 100644
--- a/src/main/java/org/apache/commons/cli/DeprecatedAttributes.java
+++ b/src/main/java/org/apache/commons/cli/DeprecatedAttributes.java
@@ -73,7 +73,7 @@ public final class DeprecatedAttributes {
/**
* Sets the description.
*
- * @param description the description.
+ * @param description The description.
* @return {@code this} instance.
*/
public Builder setDescription(final String description) {
@@ -96,7 +96,7 @@ public final class DeprecatedAttributes {
/**
* Sets the version in which the option became deprecated.
*
- * @param since the version in which the option became deprecated.
+ * @param since The version in which the option became deprecated.
* @return {@code this} instance.
*/
public Builder setSince(final String since) {
diff --git a/src/main/java/org/apache/commons/cli/HelpFormatter.java
b/src/main/java/org/apache/commons/cli/HelpFormatter.java
index 2b0d99a8..91d5b2bb 100644
--- a/src/main/java/org/apache/commons/cli/HelpFormatter.java
+++ b/src/main/java/org/apache/commons/cli/HelpFormatter.java
@@ -115,7 +115,7 @@ public class HelpFormatter {
/**
* Sets the output PrintWriter, defaults to wrapping {@link
System#out}.
*
- * @param printWriter the output PrintWriter, not null.
+ * @param printWriter The output PrintWriter, not null.
* @return {@code this} instance.
*/
public Builder setPrintWriter(final PrintWriter printWriter) {
@@ -356,8 +356,8 @@ public class HelpFormatter {
/**
* Appends the usage clause for an Option to a StringBuffer.
*
- * @param buff the StringBuffer to append to
- * @param option the Option to append
+ * @param buff The StringBuffer to append to
+ * @param option The Option to append
* @param required whether the Option is required or not
*/
private void appendOption(final StringBuilder buff, final Option option,
final boolean required) {
@@ -384,8 +384,8 @@ public class HelpFormatter {
* Appends the usage clause for an OptionGroup to a StringBuffer. The
clause is wrapped in square brackets if the group
* is required. The display of the options is handled by appendOption
*
- * @param buff the StringBuilder to append to
- * @param optionGroup the group to append
+ * @param buff The StringBuilder to append to
+ * @param optionGroup The group to append
* @see #appendOption(StringBuilder,Option,boolean)
*/
private void appendOptionGroup(final StringBuilder buff, final OptionGroup
optionGroup) {
@@ -415,8 +415,8 @@ public class HelpFormatter {
* @param sb The StringBuffer to place the rendered Options into.
* @param width The number of characters to display per line
* @param options The command line Options
- * @param leftPad the number of characters of padding to be prefixed to
each line
- * @param descPad the number of characters of padding to be prefixed to
each description line
+ * @param leftPad The number of characters of padding to be prefixed to
each line
+ * @param descPad The number of characters of padding to be prefixed to
each description line
* @return The StringBuffer with the rendered Options contents.
* @throws IOException if an I/O error occurs.
*/
@@ -690,11 +690,11 @@ public class HelpFormatter {
* Prints the help for {@code options} with the specified command line
syntax. This method prints help information
* to {@link System#out} by default.
*
- * @param width the number of characters to be displayed on each line
- * @param cmdLineSyntax the syntax for this application
- * @param header the banner to display at the beginning of the help
- * @param options the Options instance
- * @param footer the banner to display at the end of the help
+ * @param width The number of characters to be displayed on each line
+ * @param cmdLineSyntax The syntax for this application
+ * @param header The banner to display at the beginning of the help
+ * @param options The Options instance
+ * @param footer The banner to display at the end of the help
*/
public void printHelp(final int width, final String cmdLineSyntax, final
String header, final Options options, final String footer) {
printHelp(width, cmdLineSyntax, header, options, footer, false);
@@ -704,11 +704,11 @@ public class HelpFormatter {
* Prints the help for {@code options} with the specified command line
syntax. This method prints help information
* to {@link System#out} by default.
*
- * @param width the number of characters to be displayed on each line
- * @param cmdLineSyntax the syntax for this application
- * @param header the banner to display at the beginning of the help
- * @param options the Options instance
- * @param footer the banner to display at the end of the help
+ * @param width The number of characters to be displayed on each line
+ * @param cmdLineSyntax The syntax for this application
+ * @param header The banner to display at the beginning of the help
+ * @param options The Options instance
+ * @param footer The banner to display at the end of the help
* @param autoUsage whether to print an automatically generated usage
statement
*/
public void printHelp(final int width, final String cmdLineSyntax, final
String header, final Options options, final String footer,
@@ -721,14 +721,14 @@ public class HelpFormatter {
/**
* Prints the help for {@code options} with the specified command line
syntax.
*
- * @param pw the writer to which the help will be written
- * @param width the number of characters to be displayed on each line
- * @param cmdLineSyntax the syntax for this application
- * @param header the banner to display at the beginning of the help
- * @param options the Options instance
- * @param leftPad the number of characters of padding to be prefixed to
each line
- * @param descPad the number of characters of padding to be prefixed to
each description line
- * @param footer the banner to display at the end of the help
+ * @param pw The writer to which the help will be written
+ * @param width The number of characters to be displayed on each line
+ * @param cmdLineSyntax The syntax for this application
+ * @param header The banner to display at the beginning of the help
+ * @param options The Options instance
+ * @param leftPad The number of characters of padding to be prefixed to
each line
+ * @param descPad The number of characters of padding to be prefixed to
each description line
+ * @param footer The banner to display at the end of the help
* @throws IllegalStateException if there is no room to print a line
*/
public void printHelp(final PrintWriter pw, final int width, final String
cmdLineSyntax, final String header, final Options options, final int leftPad,
@@ -739,14 +739,14 @@ public class HelpFormatter {
/**
* Prints the help for {@code options} with the specified command line
syntax.
*
- * @param pw the writer to which the help will be written
- * @param width the number of characters to be displayed on each line
- * @param cmdLineSyntax the syntax for this application
- * @param header the banner to display at the beginning of the help
- * @param options the Options instance
- * @param leftPad the number of characters of padding to be prefixed to
each line
- * @param descPad the number of characters of padding to be prefixed to
each description line
- * @param footer the banner to display at the end of the help
+ * @param pw The writer to which the help will be written
+ * @param width The number of characters to be displayed on each line
+ * @param cmdLineSyntax The syntax for this application
+ * @param header The banner to display at the beginning of the help
+ * @param options The Options instance
+ * @param leftPad The number of characters of padding to be prefixed to
each line
+ * @param descPad The number of characters of padding to be prefixed to
each description line
+ * @param footer The banner to display at the end of the help
* @param autoUsage whether to print an automatically generated usage
statement
* @throws IllegalStateException if there is no room to print a line
*/
@@ -773,8 +773,8 @@ public class HelpFormatter {
* Prints the help for {@code options} with the specified command line
syntax. This method prints help information
* to {@link System#out} by default.
*
- * @param cmdLineSyntax the syntax for this application
- * @param options the Options instance
+ * @param cmdLineSyntax The syntax for this application
+ * @param options The Options instance
*/
public void printHelp(final String cmdLineSyntax, final Options options) {
printHelp(getWidth(), cmdLineSyntax, null, options, null, false);
@@ -784,8 +784,8 @@ public class HelpFormatter {
* Prints the help for {@code options} with the specified command line
syntax. This method prints help information
* to {@link System#out} by default.
*
- * @param cmdLineSyntax the syntax for this application
- * @param options the Options instance
+ * @param cmdLineSyntax The syntax for this application
+ * @param options The Options instance
* @param autoUsage whether to print an automatically generated usage
statement
*/
public void printHelp(final String cmdLineSyntax, final Options options,
final boolean autoUsage) {
@@ -796,10 +796,10 @@ public class HelpFormatter {
* Prints the help for {@code options} with the specified command line
syntax. This method prints help information
* to {@link System#out} by default.
*
- * @param cmdLineSyntax the syntax for this application
- * @param header the banner to display at the beginning of the help
- * @param options the Options instance
- * @param footer the banner to display at the end of the help
+ * @param cmdLineSyntax The syntax for this application
+ * @param header The banner to display at the beginning of the help
+ * @param options The Options instance
+ * @param footer The banner to display at the end of the help
*/
public void printHelp(final String cmdLineSyntax, final String header,
final Options options, final String footer) {
printHelp(cmdLineSyntax, header, options, footer, false);
@@ -809,10 +809,10 @@ public class HelpFormatter {
* Prints the help for {@code options} with the specified command line
syntax. This method prints help information
* to {@link System#out} by default.
*
- * @param cmdLineSyntax the syntax for this application
- * @param header the banner to display at the beginning of the help
- * @param options the Options instance
- * @param footer the banner to display at the end of the help
+ * @param cmdLineSyntax The syntax for this application
+ * @param header The banner to display at the beginning of the help
+ * @param options The Options instance
+ * @param footer The banner to display at the end of the help
* @param autoUsage whether to print an automatically generated usage
statement
*/
public void printHelp(final String cmdLineSyntax, final String header,
final Options options, final String footer, final boolean autoUsage) {
@@ -826,8 +826,8 @@ public class HelpFormatter {
* @param pw The printWriter to write the help to
* @param width The number of characters to display per line
* @param options The command line Options
- * @param leftPad the number of characters of padding to be prefixed to
each line
- * @param descPad the number of characters of padding to be prefixed to
each description line
+ * @param leftPad The number of characters of padding to be prefixed to
each line
+ * @param descPad The number of characters of padding to be prefixed to
each description line
*/
public void printOptions(final PrintWriter pw, final int width, final
Options options, final int leftPad, final int descPad) {
try {
@@ -927,8 +927,8 @@ public class HelpFormatter {
* @param sb The StringBuffer to place the rendered Options into.
* @param width The number of characters to display per line
* @param options The command line Options
- * @param leftPad the number of characters of padding to be prefixed to
each line
- * @param descPad the number of characters of padding to be prefixed to
each description line
+ * @param leftPad The number of characters of padding to be prefixed to
each line
+ * @param descPad The number of characters of padding to be prefixed to
each description line
* @return The StringBuffer with the rendered Options contents.
*/
protected StringBuffer renderOptions(final StringBuffer sb, final int
width, final Options options, final int leftPad, final int descPad) {
@@ -1006,7 +1006,7 @@ public class HelpFormatter {
/**
* Sets the 'argName'.
*
- * @param name the new value of 'argName'
+ * @param name The new value of 'argName'
*/
public void setArgName(final String name) {
this.defaultArgName = name;
@@ -1015,7 +1015,7 @@ public class HelpFormatter {
/**
* Sets the 'descPadding'.
*
- * @param padding the new value of 'descPadding'
+ * @param padding The new value of 'descPadding'
*/
public void setDescPadding(final int padding) {
this.defaultDescPad = padding;
@@ -1024,7 +1024,7 @@ public class HelpFormatter {
/**
* Sets the 'leftPadding'.
*
- * @param padding the new value of 'leftPadding'
+ * @param padding The new value of 'leftPadding'
*/
public void setLeftPadding(final int padding) {
this.defaultLeftPad = padding;
@@ -1033,7 +1033,7 @@ public class HelpFormatter {
/**
* Sets the 'longOptPrefix'.
*
- * @param prefix the new value of 'longOptPrefix'
+ * @param prefix The new value of 'longOptPrefix'
*/
public void setLongOptPrefix(final String prefix) {
this.defaultLongOptPrefix = prefix;
@@ -1043,7 +1043,7 @@ public class HelpFormatter {
* Sets the separator displayed between a long option and its value.
Ensure that the separator specified is supported by
* the parser used, typically ' ' or '='.
*
- * @param longOptSeparator the separator, typically ' ' or '='.
+ * @param longOptSeparator The separator, typically ' ' or '='.
* @since 1.3
*/
public void setLongOptSeparator(final String longOptSeparator) {
@@ -1053,7 +1053,7 @@ public class HelpFormatter {
/**
* Sets the 'newLine'.
*
- * @param newline the new value of 'newLine'
+ * @param newline The new value of 'newLine'
*/
public void setNewLine(final String newline) {
this.defaultNewLine = newline;
@@ -1063,7 +1063,7 @@ public class HelpFormatter {
* Sets the comparator used to sort the options when they output in help
text. Passing in a null comparator will keep the
* options in the order they were declared.
*
- * @param comparator the {@link Comparator} to use for sorting the options
+ * @param comparator The {@link Comparator} to use for sorting the options
* @since 1.2
*/
public void setOptionComparator(final Comparator<Option> comparator) {
@@ -1073,7 +1073,7 @@ public class HelpFormatter {
/**
* Sets the 'optPrefix'.
*
- * @param prefix the new value of 'optPrefix'
+ * @param prefix The new value of 'optPrefix'
*/
public void setOptPrefix(final String prefix) {
this.defaultOptPrefix = prefix;
@@ -1082,7 +1082,7 @@ public class HelpFormatter {
/**
* Sets the 'syntaxPrefix'.
*
- * @param prefix the new value of 'syntaxPrefix'
+ * @param prefix The new value of 'syntaxPrefix'
*/
public void setSyntaxPrefix(final String prefix) {
this.defaultSyntaxPrefix = prefix;
@@ -1091,7 +1091,7 @@ public class HelpFormatter {
/**
* Sets the 'width'.
*
- * @param width the new value of 'width'
+ * @param width The new value of 'width'
*/
public void setWidth(final int width) {
this.defaultWidth = width;
diff --git a/src/main/java/org/apache/commons/cli/MissingArgumentException.java
b/src/main/java/org/apache/commons/cli/MissingArgumentException.java
index 95ef6da3..9ddb30e0 100644
--- a/src/main/java/org/apache/commons/cli/MissingArgumentException.java
+++ b/src/main/java/org/apache/commons/cli/MissingArgumentException.java
@@ -33,7 +33,7 @@ public class MissingArgumentException extends ParseException {
/**
* Constructs a new {@code MissingArgumentException} with the specified
detail message.
*
- * @param option the option requiring an argument
+ * @param option The option requiring an argument
* @since 1.2
*/
public MissingArgumentException(final Option option) {
@@ -44,7 +44,7 @@ public class MissingArgumentException extends ParseException {
/**
* Constructs a new {@code MissingArgumentException} with the specified
detail message.
*
- * @param message the detail message
+ * @param message The detail message
*/
public MissingArgumentException(final String message) {
super(message);
diff --git a/src/main/java/org/apache/commons/cli/MissingOptionException.java
b/src/main/java/org/apache/commons/cli/MissingOptionException.java
index 40f6c068..23e73a10 100644
--- a/src/main/java/org/apache/commons/cli/MissingOptionException.java
+++ b/src/main/java/org/apache/commons/cli/MissingOptionException.java
@@ -30,7 +30,7 @@ public class MissingOptionException extends ParseException {
/**
* Build the exception message from the specified list of options.
*
- * @param missingOptions the list of missing options and groups
+ * @param missingOptions The list of missing options and groups
*/
private static String createMessage(final List<?> missingOptions) {
final StringBuilder buf = new StringBuilder("Missing required option");
@@ -45,7 +45,7 @@ public class MissingOptionException extends ParseException {
/**
* Constructs a new {@code MissingSelectedException} with the specified
list of missing options.
*
- * @param missingOptions the list of missing options and groups
+ * @param missingOptions The list of missing options and groups
* @since 1.2
*/
public MissingOptionException(final List missingOptions) {
@@ -56,7 +56,7 @@ public class MissingOptionException extends ParseException {
/**
* Constructs a new {@code MissingSelectedException} with the specified
detail message.
*
- * @param message the detail message
+ * @param message The detail message
*/
public MissingOptionException(final String message) {
super(message);
diff --git a/src/main/java/org/apache/commons/cli/Option.java
b/src/main/java/org/apache/commons/cli/Option.java
index ce32f0bf..6062d9d8 100644
--- a/src/main/java/org/apache/commons/cli/Option.java
+++ b/src/main/java/org/apache/commons/cli/Option.java
@@ -60,7 +60,7 @@ public class Option implements Cloneable, Serializable {
/**
* Returns the input Class or the default type (String) if null.
*
- * @param type the candidate Class.
+ * @param type The candidate Class.
* @return The input Class or the default type (String) if null.
*/
private static Class<?> toType(final Class<?> type) {
@@ -116,7 +116,7 @@ public class Option implements Cloneable, Serializable {
/**
* Sets the display name for the argument value.
*
- * @param argName the display name for the argument value.
+ * @param argName The display name for the argument value.
* @return {@code this} instance..
*/
public Builder argName(final String argName) {
@@ -142,7 +142,7 @@ public class Option implements Cloneable, Serializable {
* Note: See {@link TypeHandler} for serialization discussion.
* </p>
*
- * @param converter the Converter to use.
+ * @param converter The Converter to use.
* @return {@code this} instance..
* @since 1.7.0
*/
@@ -176,7 +176,7 @@ public class Option implements Cloneable, Serializable {
/**
* Sets the description for this option.
*
- * @param description the description of the option.
+ * @param description The description of the option.
* @return {@code this} instance..
*/
public Builder desc(final String description) {
@@ -229,7 +229,7 @@ public class Option implements Cloneable, Serializable {
/**
* Sets the long name of the Option.
*
- * @param longOption the long name of the Option
+ * @param longOption The long name of the Option
* @return this builder.
*/
public Builder longOpt(final String longOption) {
@@ -240,7 +240,7 @@ public class Option implements Cloneable, Serializable {
/**
* Sets the number of argument values the Option can take.
*
- * @param argCount the number of argument values
+ * @param argCount The number of argument values
* @return this builder.
*/
public Builder numberOfArgs(final int argCount) {
@@ -251,7 +251,7 @@ public class Option implements Cloneable, Serializable {
/**
* Sets the name of the Option.
*
- * @param option the name of the Option.
+ * @param option The name of the Option.
* @return this builder.
* @throws IllegalArgumentException if there are any non valid Option
characters in {@code opt}.
* @since 1.5.0
@@ -297,7 +297,7 @@ public class Option implements Cloneable, Serializable {
/** Sets the version number when this option was first defined."
*
- * @param since the version number when this option was first defined.
+ * @param since The version number when this option was first defined.
* @return this builder.
*/
public Builder since(final String since) {
@@ -308,7 +308,7 @@ public class Option implements Cloneable, Serializable {
/**
* Sets the type of the Option.
*
- * @param type the type of the Option.
+ * @param type The type of the Option.
* @return this builder.
*/
public Builder type(final Class<?> type) {
@@ -481,7 +481,7 @@ public class Option implements Cloneable, Serializable {
* Creates an Option using the specified parameters.
*
* @param option short representation of the option.
- * @param longOption the long representation of the option.
+ * @param longOption The long representation of the option.
* @param hasArg specifies whether the Option takes an argument or
not.
* @param description describes the function of the option.
* @throws IllegalArgumentException if there are any non valid Option
characters in {@code opt}.
@@ -525,7 +525,7 @@ public class Option implements Cloneable, Serializable {
/**
* This method is not intended to be used. It was a piece of internal API
that was made public in 1.0. It currently throws an
UnsupportedOperationException.
*
- * @param value the value to add.
+ * @param value The value to add.
* @return always throws an {@link UnsupportedOperationException}.
* @throws UnsupportedOperationException always.
* @deprecated Unused.
@@ -885,7 +885,7 @@ public class Option implements Cloneable, Serializable {
/**
* Sets the display name for the argument value.
*
- * @param argName the display name for the argument value.
+ * @param argName The display name for the argument value.
*/
public void setArgName(final String argName) {
this.argName = argName;
@@ -894,7 +894,7 @@ public class Option implements Cloneable, Serializable {
/**
* Sets the number of argument values this Option can take.
*
- * @param num the number of argument values.
+ * @param num The number of argument values.
*/
public void setArgs(final int num) {
this.argCount = num;
@@ -923,7 +923,7 @@ public class Option implements Cloneable, Serializable {
/**
* Sets the long name of this Option.
*
- * @param longOpt the long name of this Option.
+ * @param longOpt The long name of this Option.
*/
public void setLongOpt(final String longOpt) {
this.longOption = longOpt;
@@ -950,7 +950,7 @@ public class Option implements Cloneable, Serializable {
/**
* Sets the type of this Option.
*
- * @param type the type of this Option.
+ * @param type The type of this Option.
* @since 1.3
*/
public void setType(final Class<?> type) {
@@ -963,7 +963,7 @@ public class Option implements Cloneable, Serializable {
* <strong>Note:</strong> this method is kept for binary compatibility and
the input type is supposed to be a {@link Class} object.
* </p>
*
- * @param type the type of this Option.
+ * @param type The type of this Option.
* @deprecated Since 1.3, use {@link #setType(Class)} instead.
*/
@Deprecated
diff --git a/src/main/java/org/apache/commons/cli/OptionBuilder.java
b/src/main/java/org/apache/commons/cli/OptionBuilder.java
index c97d8468..b21ee05b 100644
--- a/src/main/java/org/apache/commons/cli/OptionBuilder.java
+++ b/src/main/java/org/apache/commons/cli/OptionBuilder.java
@@ -80,7 +80,7 @@ public final class OptionBuilder {
/**
* Creates an Option using the current settings and with the specified
Option {@code char}.
*
- * @param opt the character representation of the Option.
+ * @param opt The character representation of the Option.
* @return The Option instance.
* @throws IllegalArgumentException if {@code opt} is not a valid
character. See Option.
*/
@@ -91,7 +91,7 @@ public final class OptionBuilder {
/**
* Creates an Option using the current settings and with the specified
Option {@code char}.
*
- * @param opt the {@code String} representation of the Option.
+ * @param opt The {@code String} representation of the Option.
* @return The Option instance.
* @throws IllegalArgumentException if {@code opt} is not a valid
character. See Option.
*/
@@ -151,7 +151,7 @@ public final class OptionBuilder {
/**
* The next Option created can have {@code num} argument values.
*
- * @param num the number of args that the option can have.
+ * @param num The number of args that the option can have.
* @return The OptionBuilder instance.
*/
public static OptionBuilder hasArgs(final int num) {
@@ -184,7 +184,7 @@ public final class OptionBuilder {
/**
* The next Option can have the specified number of optional arguments.
*
- * @param numArgs the maximum number of optional arguments the next
Option created can have.
+ * @param numArgs The maximum number of optional arguments the next
Option created can have.
* @return The OptionBuilder instance.
*/
public static OptionBuilder hasOptionalArgs(final int numArgs) {
@@ -231,7 +231,7 @@ public final class OptionBuilder {
/**
* The next Option created will have the specified argument value name.
*
- * @param name the name for the argument value.
+ * @param name The name for the argument value.
* @return The OptionBuilder instance.
*/
public static OptionBuilder withArgName(final String name) {
@@ -242,7 +242,7 @@ public final class OptionBuilder {
/**
* The next Option created will have the specified description
*
- * @param newDescription a description of the Option's purpose.
+ * @param newDescription A description of the Option's purpose.
* @return The OptionBuilder instance.
*/
public static OptionBuilder withDescription(final String newDescription) {
@@ -253,7 +253,7 @@ public final class OptionBuilder {
/**
* The next Option created will have the following long option value.
*
- * @param newLongopt the long option value.
+ * @param newLongopt The long option value.
* @return The OptionBuilder instance.
*/
public static OptionBuilder withLongOpt(final String newLongopt) {
@@ -264,7 +264,7 @@ public final class OptionBuilder {
/**
* The next Option created will have a value that will be an instance of
{@code type}.
*
- * @param newType the type of the Options argument value.
+ * @param newType The type of the Options argument value.
* @return The OptionBuilder instance.
* @since 1.3
*/
@@ -279,7 +279,7 @@ public final class OptionBuilder {
* <strong>Note:</strong> this method is kept for binary compatibility and
the input type is supposed to be a {@link Class}
* object.
*
- * @param newType the type of the Options argument value.
+ * @param newType The type of the Options argument value.
* @return The OptionBuilder instance.
* @deprecated Since 1.3, use {@link #withType(Class)} instead.
*/
diff --git a/src/main/java/org/apache/commons/cli/OptionGroup.java
b/src/main/java/org/apache/commons/cli/OptionGroup.java
index cf092c36..ce5384f4 100644
--- a/src/main/java/org/apache/commons/cli/OptionGroup.java
+++ b/src/main/java/org/apache/commons/cli/OptionGroup.java
@@ -54,7 +54,7 @@ public class OptionGroup implements Serializable {
/**
* Adds the given {@code Option} to this group.
*
- * @param option the option to add to this group.
+ * @param option The option to add to this group.
* @return this option group with the option added.
*/
public OptionGroup addOption(final Option option) {
@@ -128,7 +128,7 @@ public class OptionGroup implements Serializable {
*
* If the selected option is deprecated <em>no warning is logged</em>.
*
- * @param option the option that is selected.
+ * @param option The option that is selected.
* @throws AlreadySelectedException if an option from this group has
already been selected.
*/
public void setSelected(final Option option) throws
AlreadySelectedException {
diff --git a/src/main/java/org/apache/commons/cli/OptionValidator.java
b/src/main/java/org/apache/commons/cli/OptionValidator.java
index db2688ae..ab48847e 100644
--- a/src/main/java/org/apache/commons/cli/OptionValidator.java
+++ b/src/main/java/org/apache/commons/cli/OptionValidator.java
@@ -45,7 +45,7 @@ final class OptionValidator {
* <li>it is a hyphen/dash ('-')</li>
* </ul>
*
- * @param c the character to validate
+ * @param c The character to validate
* @return true if {@code c} is a valid character letter.
*/
private static boolean isValidChar(final char c) {
@@ -67,7 +67,7 @@ final class OptionValidator {
* <li>it is a question mark or 'at' sign ('?' or '@')</li>
* </ul>
*
- * @param c the option to validate
+ * @param c The option to validate
* @return true if {@code c} is a letter, '?' or '@', otherwise false.
*/
private static boolean isValidOpt(final char c) {
@@ -77,8 +77,8 @@ final class OptionValidator {
/**
* Checks the char array for a matching char.
*
- * @param chars the char array to search
- * @param c the char to look for.
+ * @param chars The char array to search
+ * @param c The char to look for.
* @return {@code true} if {@code c} was in {@code ary}, {@code false}
otherwise.
*/
private static boolean search(final char[] chars, final char c) {
diff --git a/src/main/java/org/apache/commons/cli/Options.java
b/src/main/java/org/apache/commons/cli/Options.java
index 4c8ef9e9..40d8b110 100644
--- a/src/main/java/org/apache/commons/cli/Options.java
+++ b/src/main/java/org/apache/commons/cli/Options.java
@@ -67,7 +67,7 @@ public class Options implements Serializable {
/**
* Adds an option instance.
*
- * @param opt the option that is to be added.
+ * @param opt The option that is to be added.
* @return The resulting Options instance.
*/
public Options addOption(final Option opt) {
@@ -143,7 +143,7 @@ public class Options implements Serializable {
* the given group are set to optional.
* </p>
*
- * @param optionGroup the OptionGroup that is to be added.
+ * @param optionGroup The OptionGroup that is to be added.
* @return The resulting Options instance.
*/
public Options addOptionGroup(final OptionGroup optionGroup) {
@@ -167,7 +167,7 @@ public class Options implements Serializable {
* Adds options to this option. If any Option in {@code options} already
exists
* in this Options an IllegalArgumentException is thrown.
*
- * @param options the options to add.
+ * @param options The options to add.
* @return The resulting Options instance.
* @since 1.7.0
*/
@@ -212,7 +212,7 @@ public class Options implements Serializable {
/**
* Gets the options with a long name starting with the name specified.
*
- * @param opt the partial name of the option.
+ * @param opt The partial name of the option.
* @return The options matching the partial name specified, or an empty
list if none matches.
* @since 1.3
*/
@@ -249,7 +249,7 @@ public class Options implements Serializable {
/**
* Gets the OptionGroup the {@code opt} belongs to.
*
- * @param option the option whose OptionGroup is being queried.
+ * @param option The option whose OptionGroup is being queried.
* @return The OptionGroup if {@code opt} is part of an OptionGroup,
otherwise return null.
*/
public OptionGroup getOptionGroup(final Option option) {
diff --git a/src/main/java/org/apache/commons/cli/ParseException.java
b/src/main/java/org/apache/commons/cli/ParseException.java
index da501fd1..f322d847 100644
--- a/src/main/java/org/apache/commons/cli/ParseException.java
+++ b/src/main/java/org/apache/commons/cli/ParseException.java
@@ -34,7 +34,7 @@ public class ParseException extends Exception {
* Note: {@code UnsupportedOperationException} are not wrapped. This is to
solve a legacy expected exception problem and will be removed in the future.
* </p>
*
- * @param e the exception to convert.
+ * @param e The exception to convert.
* @return The ParseException.
* @throws UnsupportedOperationException due to legacy expectations. Will
be removed in the future.
* @since 1.7.0
@@ -53,7 +53,7 @@ public class ParseException extends Exception {
/**
* Constructs a new {@code ParseException} with the specified detail
message.
*
- * @param message the detail message.
+ * @param message The detail message.
*/
public ParseException(final String message) {
super(message);
@@ -62,7 +62,7 @@ public class ParseException extends Exception {
/**
* Constructs a new {@code ParseException} wrapping the specified
exception.
*
- * @param e the Exception to wrap.
+ * @param e The Exception to wrap.
*/
public ParseException(final Throwable e) {
super(e);
diff --git a/src/main/java/org/apache/commons/cli/Parser.java
b/src/main/java/org/apache/commons/cli/Parser.java
index 19f01cc7..d120ea21 100644
--- a/src/main/java/org/apache/commons/cli/Parser.java
+++ b/src/main/java/org/apache/commons/cli/Parser.java
@@ -94,8 +94,8 @@ public abstract class Parser implements CommandLineParser {
/**
* Parses the specified {@code arguments} based on the specified {@link
Options}.
*
- * @param options the {@code Options}.
- * @param arguments the {@code arguments}.
+ * @param options The {@code Options}.
+ * @param arguments The {@code arguments}.
* @return The {@code CommandLine}.
* @throws ParseException if there are any problems encountered while
parsing the command line tokens.
*/
@@ -107,8 +107,8 @@ public abstract class Parser implements CommandLineParser {
/**
* Parses the specified {@code arguments} based on the specified {@link
Options}.
*
- * @param options the {@code Options}.
- * @param arguments the {@code arguments}.
+ * @param options The {@code Options}.
+ * @param arguments The {@code arguments}.
* @param stopAtNonOption if {@code true} an unrecognized argument stops
the parsing and the remaining arguments
* are added to the {@link CommandLine}s args list. If {@code
false} an unrecognized argument triggers a
* ParseException.
@@ -123,8 +123,8 @@ public abstract class Parser implements CommandLineParser {
/**
* Parses the arguments according to the specified options and properties.
*
- * @param options the specified Options.
- * @param arguments the command line arguments.
+ * @param options The specified Options.
+ * @param arguments The command line arguments.
* @param properties command line option name-value pairs.
* @return The list of atomic option and value tokens.
* @throws ParseException if there are any problems encountered while
parsing the command line tokens.
@@ -137,8 +137,8 @@ public abstract class Parser implements CommandLineParser {
/**
* Parses the arguments according to the specified options and properties.
*
- * @param options the specified Options.
- * @param arguments the command line arguments.
+ * @param options The specified Options.
+ * @param arguments The command line arguments.
* @param properties command line option name-value pairs.
* @param stopAtNonOption if {@code true} an unrecognized argument stops
the parsing and the remaining arguments
* are added to the {@link CommandLine}s args list. If {@code
false} an unrecognized argument triggers a
@@ -306,7 +306,7 @@ public abstract class Parser implements CommandLineParser {
/**
* Sets the options.
*
- * @param options the options.
+ * @param options The options.
*/
protected void setOptions(final Options options) {
this.options = options;
@@ -316,7 +316,7 @@ public abstract class Parser implements CommandLineParser {
/**
* Removes the option or its group from the list of expected elements.
*
- * @param opt the option.
+ * @param opt The option.
*/
private void updateRequiredOptions(final Option opt) throws ParseException
{
// if the option is a required option remove the option from
diff --git a/src/main/java/org/apache/commons/cli/PatternOptionBuilder.java
b/src/main/java/org/apache/commons/cli/PatternOptionBuilder.java
index 43b36abf..f68cfaea 100644
--- a/src/main/java/org/apache/commons/cli/PatternOptionBuilder.java
+++ b/src/main/java/org/apache/commons/cli/PatternOptionBuilder.java
@@ -113,7 +113,7 @@ public class PatternOptionBuilder {
/**
* Retrieve the class that {@code ch} represents.
*
- * @param ch the specified character.
+ * @param ch The specified character.
* @return The class that {@code ch} represents.
* @deprecated Use {@link #getValueType(char)}.
*/
@@ -125,7 +125,7 @@ public class PatternOptionBuilder {
/**
* Retrieve the class that {@code ch} represents.
*
- * @param ch the specified character
+ * @param ch The specified character
* @return The class that {@code ch} represents
* @since 1.7.0
*/
@@ -157,7 +157,7 @@ public class PatternOptionBuilder {
/**
* Returns whether {@code ch} is a value code, i.e. whether it represents
a class in a pattern.
*
- * @param ch the specified character
+ * @param ch The specified character
* @return true if {@code ch} is a value code, otherwise false.
*/
public static boolean isValueCode(final char ch) {
@@ -167,7 +167,7 @@ public class PatternOptionBuilder {
/**
* Returns the {@link Options} instance represented by {@code pattern}.
*
- * @param pattern the pattern string
+ * @param pattern The pattern string
* @return The {@link Options} instance
*/
public static Options parsePattern(final String pattern) {
diff --git a/src/main/java/org/apache/commons/cli/TypeHandler.java
b/src/main/java/org/apache/commons/cli/TypeHandler.java
index 5cc0bef9..d889dfcf 100644
--- a/src/main/java/org/apache/commons/cli/TypeHandler.java
+++ b/src/main/java/org/apache/commons/cli/TypeHandler.java
@@ -50,7 +50,7 @@ public class TypeHandler {
/**
* Returns the class whose name is {@code className}.
*
- * @param className the class name.
+ * @param className The class name.
* @return The class if it is found.
* @throws ParseException if the class could not be found.
*/
@@ -64,7 +64,7 @@ public class TypeHandler {
* This method is not yet implemented and always throws an {@link
UnsupportedOperationException}.
* </p>
*
- * @param string the date string.
+ * @param string The date string.
* @return The date if {@code string} is a valid date string, otherwise
return null.
*/
public static Date createDate(final String string) {
@@ -84,7 +84,7 @@ public class TypeHandler {
/**
* Returns the File represented by {@code string}.
*
- * @param string the File location.
+ * @param string The File location.
* @return The file represented by {@code string}.
*/
public static File createFile(final String string) {
@@ -98,7 +98,7 @@ public class TypeHandler {
* This method is not yet implemented and always throws an {@link
UnsupportedOperationException}.
* </p>
*
- * @param string the paths to the files.
+ * @param string The paths to the files.
* @return The File[] represented by {@code string}.
* @throws UnsupportedOperationException always.
* @deprecated Without replacement.
@@ -113,7 +113,7 @@ public class TypeHandler {
/**
* Creates a number from a String. If a '.' is present, it creates a
Double, otherwise a Long.
*
- * @param string the value.
+ * @param string The value.
* @return The number represented by {@code string}.
* @throws ParseException if {@code string} is not a number.
*/
@@ -125,7 +125,7 @@ public class TypeHandler {
/**
* Creates an Object from the class name and empty constructor.
*
- * @param className the argument value.
+ * @param className The argument value.
* @return The initialized object.
* @throws ParseException if the class could not be found or the object
could not be created.
* @deprecated Use {@link #createValue(String, Class)}.
@@ -138,7 +138,7 @@ public class TypeHandler {
/**
* Creates the URL represented by {@code string}.
*
- * @param string the URL string.
+ * @param string The URL string.
* @return The URL in {@code string} is well-formed.
* @throws ParseException if the URL in {@code string} is not well-formed.
*/
@@ -149,8 +149,8 @@ public class TypeHandler {
/**
* Creates the @code Object} of type {@code clazz} with the value of
{@code string}.
*
- * @param string the command line value.
- * @param clazz the class representing the type of argument.
+ * @param string The command line value.
+ * @param clazz The class representing the type of argument.
* @param <T> type of argument.
* @return The instance of {@code clazz} initialized with the value of
{@code string}.
* @throws ParseException if the value creation for the given class threw
an exception.
@@ -166,8 +166,8 @@ public class TypeHandler {
/**
* Creates the {@code Object} of type {@code obj} with the value of {@code
string}.
*
- * @param string the command line value.
- * @param obj the type of argument.
+ * @param string The command line value.
+ * @param obj The type of argument.
* @return The instance of {@code obj} initialized with the value of
{@code string}.
* @throws ParseException if the value creation for the given object type
failed.
* @deprecated Use {@link #createValue(String, Class)}.
@@ -180,8 +180,8 @@ public class TypeHandler {
/**
* Delegates to {@link #createValue(String, Class)} throwing
IllegalArgumentException instead of ParseException.
*
- * @param string the command line value.
- * @param clazz the class representing the type of argument.
+ * @param string The command line value.
+ * @param clazz The class representing the type of argument.
* @param <T> type of argument.
* @return The instance of {@code clazz} initialized with the value of
{@code string}.
* @throws IllegalArgumentException if the value creation for the given
class threw an exception.
@@ -207,7 +207,7 @@ public class TypeHandler {
/**
* Returns the opened FileInputStream represented by {@code string}.
*
- * @param string the file location.
+ * @param string The file location.
* @return The file input stream represented by {@code string}.
* @throws ParseException if the file is not exist or not readable.
* @deprecated Use {@link #createValue(String, Class)}.
diff --git
a/src/main/java/org/apache/commons/cli/UnrecognizedOptionException.java
b/src/main/java/org/apache/commons/cli/UnrecognizedOptionException.java
index 6428d223..6677fc6e 100644
--- a/src/main/java/org/apache/commons/cli/UnrecognizedOptionException.java
+++ b/src/main/java/org/apache/commons/cli/UnrecognizedOptionException.java
@@ -33,7 +33,7 @@ public class UnrecognizedOptionException extends
ParseException {
/**
* Constructs a new {@code UnrecognizedArgumentException} with the
specified detail message.
*
- * @param message the detail message.
+ * @param message The detail message.
*/
public UnrecognizedOptionException(final String message) {
this(message, null);
@@ -42,8 +42,8 @@ public class UnrecognizedOptionException extends
ParseException {
/**
* Constructs a new {@code UnrecognizedArgumentException} with the
specified option and detail message.
*
- * @param message the detail message.
- * @param option the unrecognized option.
+ * @param message The detail message.
+ * @param option The unrecognized option.
* @since 1.2
*/
public UnrecognizedOptionException(final String message, final String
option) {
diff --git a/src/main/java/org/apache/commons/cli/Util.java
b/src/main/java/org/apache/commons/cli/Util.java
index fa18bb1c..7ecf0544 100644
--- a/src/main/java/org/apache/commons/cli/Util.java
+++ b/src/main/java/org/apache/commons/cli/Util.java
@@ -32,7 +32,7 @@ final class Util {
/**
* Tests whether the given array is null or empty.
*
- * @param array the array to test.
+ * @param array The array to test.
* @return The given array is null or empty.
*/
static boolean isEmpty(final Object[] array) {
diff --git
a/src/main/java/org/apache/commons/cli/help/AbstractHelpFormatter.java
b/src/main/java/org/apache/commons/cli/help/AbstractHelpFormatter.java
index ef53ad28..3007a9f5 100644
--- a/src/main/java/org/apache/commons/cli/help/AbstractHelpFormatter.java
+++ b/src/main/java/org/apache/commons/cli/help/AbstractHelpFormatter.java
@@ -132,7 +132,7 @@ public abstract class AbstractHelpFormatter {
/**
* Sets the {@link HelpAppendable}.
*
- * @param helpAppendable the {@link HelpAppendable} to use.
+ * @param helpAppendable The {@link HelpAppendable} to use.
* @return {@code this} instance.
*/
public B setHelpAppendable(final HelpAppendable helpAppendable) {
@@ -143,7 +143,7 @@ public abstract class AbstractHelpFormatter {
/**
* Sets the {@link OptionFormatter.Builder}.
*
- * @param optionFormatBuilder the {@link OptionFormatter.Builder} to
use.
+ * @param optionFormatBuilder The {@link OptionFormatter.Builder} to
use.
* @return {@code this} instance.
*/
public B setOptionFormatBuilder(final OptionFormatter.Builder
optionFormatBuilder) {
@@ -154,7 +154,7 @@ public abstract class AbstractHelpFormatter {
/**
* Sets the OptionGroup separator. Normally " | " or something similar
to denote that only one option may be chosen.
*
- * @param optionGroupSeparator the string to separate option group
elements with.
+ * @param optionGroupSeparator The string to separate option group
elements with.
* @return {@code this} instance.
*/
public B setOptionGroupSeparator(final String optionGroupSeparator) {
@@ -203,7 +203,7 @@ public abstract class AbstractHelpFormatter {
/**
* Constructs the base formatter.
*
- * @param builder the builder.
+ * @param builder The builder.
*/
protected AbstractHelpFormatter(final Builder<?, ?> builder) {
this.helpAppendable =
Objects.requireNonNull(builder.getHelpAppendable(), "helpAppendable");
@@ -288,8 +288,8 @@ public abstract class AbstractHelpFormatter {
* Prints the help for {@link Options} with the specified command line
syntax,
* without printing a header, footer, or autoUsage.
*
- * @param cmdLineSyntax the syntax for this application.
- * @param options the collection of {@link Option} objects to print.
+ * @param cmdLineSyntax The syntax for this application.
+ * @param options The collection of {@link Option} objects to print.
* @throws IOException If the output could not be written to the {@link
HelpAppendable}.
* @since 1.12.0
*/
@@ -300,10 +300,10 @@ public abstract class AbstractHelpFormatter {
/**
* Prints the help for {@link Options} with the specified command line
syntax.
*
- * @param cmdLineSyntax the syntax for this application.
- * @param header the banner to display at the beginning of the help.
- * @param options the collection of {@link Option} objects to print.
- * @param footer the banner to display at the end of the help.
+ * @param cmdLineSyntax The syntax for this application.
+ * @param header The banner to display at the beginning of the help.
+ * @param options The collection of {@link Option} objects to print.
+ * @param footer The banner to display at the end of the help.
* @param autoUsage whether to print an automatically generated usage
statement.
* @throws IOException If the output could not be written to the {@link
HelpAppendable}.
*/
@@ -317,10 +317,10 @@ public abstract class AbstractHelpFormatter {
/**
* Prints the help for a collection of {@link Option}s with the specified
command line syntax.
*
- * @param cmdLineSyntax the syntax for this application.
- * @param header the banner to display at the beginning of the help.
- * @param options the collection of {@link Option} objects to print.
- * @param footer the banner to display at the end of the help.
+ * @param cmdLineSyntax The syntax for this application.
+ * @param header The banner to display at the beginning of the help.
+ * @param options The collection of {@link Option} objects to print.
+ * @param footer The banner to display at the end of the help.
* @param autoUsage whether to print an automatically generated usage
statement.
* @throws IOException If the output could not be written to the {@link
HelpAppendable}.
*/
@@ -346,7 +346,7 @@ public abstract class AbstractHelpFormatter {
/**
* Prints the option table for a collection of {@link Option} objects to
the {@link HelpAppendable}.
*
- * @param options the collection of Option objects to print in the table.
+ * @param options The collection of Option objects to print in the table.
* @throws IOException If the output could not be written to the {@link
HelpAppendable}.
*/
public final void printOptions(final Iterable<Option> options) throws
IOException {
@@ -356,7 +356,7 @@ public abstract class AbstractHelpFormatter {
/**
* Prints the option table for the specified {@link Options} to the {@link
HelpAppendable}.
*
- * @param options the Options to print in the table.
+ * @param options The Options to print in the table.
* @throws IOException If the output could not be written to the {@link
HelpAppendable}.
*/
public final void printOptions(final Options options) throws IOException {
@@ -366,7 +366,7 @@ public abstract class AbstractHelpFormatter {
/**
* Prints a {@link TableDefinition} to the {@link HelpAppendable}.
*
- * @param tableDefinition the {@link TableDefinition} to print.
+ * @param tableDefinition The {@link TableDefinition} to print.
* @throws IOException If the output could not be written to the {@link
HelpAppendable}.
*/
public final void printOptions(final TableDefinition tableDefinition)
throws IOException {
@@ -376,7 +376,7 @@ public abstract class AbstractHelpFormatter {
/**
* Sets the syntax prefix. This is the phrase that is printed before the
syntax line.
*
- * @param prefix the new value for the syntax prefix.
+ * @param prefix The new value for the syntax prefix.
*/
public final void setSyntaxPrefix(final String prefix) {
this.syntaxPrefix = prefix;
@@ -385,7 +385,7 @@ public abstract class AbstractHelpFormatter {
/**
* Creates a new list of options ordered by the comparator.
*
- * @param options the Options to sort.
+ * @param options The Options to sort.
* @return A new list of options ordered by the comparator.
*/
public List<Option> sort(final Iterable<Option> options) {
@@ -400,7 +400,7 @@ public abstract class AbstractHelpFormatter {
/**
* Creates a new list of options ordered by the comparator.
*
- * @param options the Options to sort.
+ * @param options The Options to sort.
* @return A new list of options ordered by the comparator.
*/
public List<Option> sort(final Options options) {
@@ -410,7 +410,7 @@ public abstract class AbstractHelpFormatter {
/**
* Formats the {@code argName} as an argument a defined in the enclosed
{@link OptionFormatter.Builder}.
*
- * @param argName the string to format as an argument.
+ * @param argName The string to format as an argument.
* @return The {@code argName} formatted as an argument.
*/
public final String toArgName(final String argName) {
@@ -436,7 +436,7 @@ public abstract class AbstractHelpFormatter {
* Return the string representation of the options as used in the syntax
display.
*
* @param options The options to create the string representation for.
- * @param lookup a function to determine if the Option is part of an
OptionGroup that has already been processed.
+ * @param lookup A function to determine if the Option is part of an
OptionGroup that has already been processed.
* @return The string representation of the options as used in the syntax
display.
*/
protected String toSyntaxOptions(final Iterable<Option> options, final
Function<Option, OptionGroup> lookup) {
diff --git
a/src/main/java/org/apache/commons/cli/help/FilterHelpAppendable.java
b/src/main/java/org/apache/commons/cli/help/FilterHelpAppendable.java
index b583fff8..b3c5a81d 100644
--- a/src/main/java/org/apache/commons/cli/help/FilterHelpAppendable.java
+++ b/src/main/java/org/apache/commons/cli/help/FilterHelpAppendable.java
@@ -45,7 +45,7 @@ public abstract class FilterHelpAppendable implements
HelpAppendable {
/**
* Constructs an appendable filter built on top of the specified
underlying appendable.
*
- * @param output the underlying appendable to be assigned to the field
{@code this.output} for later use, or {@code null} if this instance is to be
created
+ * @param output The underlying appendable to be assigned to the field
{@code this.output} for later use, or {@code null} if this instance is to be
created
* without an underlying stream.
*/
protected FilterHelpAppendable(final Appendable output) {
diff --git a/src/main/java/org/apache/commons/cli/help/HelpAppendable.java
b/src/main/java/org/apache/commons/cli/help/HelpAppendable.java
index 921a0be3..27c3b27e 100644
--- a/src/main/java/org/apache/commons/cli/help/HelpAppendable.java
+++ b/src/main/java/org/apache/commons/cli/help/HelpAppendable.java
@@ -61,8 +61,8 @@ public interface HelpAppendable extends Appendable {
/**
* Appends a header.
*
- * @param level the level of the header. This is equivalent to the "1",
"2", or "3" in the HTML "h1", "h2", "h3" tags.
- * @param text the text for the header, null is a noop.
+ * @param level The level of the header. This is equivalent to the "1",
"2", or "3" in the HTML "h1", "h2", "h3" tags.
+ * @param text The text for the header, null is a noop.
* @throws IOException If an output error occurs.
*/
void appendHeader(int level, CharSequence text) throws IOException;
@@ -71,7 +71,7 @@ public interface HelpAppendable extends Appendable {
* Appends a list.
*
* @param ordered {@code true} if the list should be ordered.
- * @param list the list to write, null is a noop.
+ * @param list The list to write, null is a noop.
* @throws IOException If an output error occurs.
*/
void appendList(boolean ordered, Collection<CharSequence> list) throws
IOException;
@@ -79,7 +79,7 @@ public interface HelpAppendable extends Appendable {
/**
* Appends a paragraph.
*
- * @param paragraph the paragraph to write, null is a noop.
+ * @param paragraph The paragraph to write, null is a noop.
* @throws IOException If an output error occurs.
*/
void appendParagraph(CharSequence paragraph) throws IOException;
@@ -106,7 +106,7 @@ public interface HelpAppendable extends Appendable {
/**
* Appends a table.
*
- * @param table the table definition to write, null is a noop.
+ * @param table The table definition to write, null is a noop.
* @throws IOException If an output error occurs.
*/
void appendTable(TableDefinition table) throws IOException;
@@ -114,7 +114,7 @@ public interface HelpAppendable extends Appendable {
/**
* Appends a title.
*
- * @param title the title to write, null is a noop.
+ * @param title The title to write, null is a noop.
* @throws IOException If an output error occurs.
*/
void appendTitle(CharSequence title) throws IOException;
diff --git a/src/main/java/org/apache/commons/cli/help/HelpFormatter.java
b/src/main/java/org/apache/commons/cli/help/HelpFormatter.java
index 43c57393..d47b8526 100644
--- a/src/main/java/org/apache/commons/cli/help/HelpFormatter.java
+++ b/src/main/java/org/apache/commons/cli/help/HelpFormatter.java
@@ -92,7 +92,7 @@ public class HelpFormatter extends AbstractHelpFormatter {
/**
* Sets the showSince flag.
*
- * @param showSince the desired value of the showSince flag.
+ * @param showSince The desired value of the showSince flag.
* @return {@code this} instance.
*/
public Builder setShowSince(final boolean showSince) {
@@ -146,7 +146,7 @@ public class HelpFormatter extends AbstractHelpFormatter {
/**
* Constructs the Help formatter.
*
- * @param builder the Builder to build from.
+ * @param builder The Builder to build from.
*/
protected HelpFormatter(final Builder builder) {
super(builder);
@@ -156,7 +156,7 @@ public class HelpFormatter extends AbstractHelpFormatter {
/**
* Gets the table definition for the options.
*
- * @param options the collection of {@link Option} instances to create the
table from.
+ * @param options The collection of {@link Option} instances to create the
table from.
* @return A {@link TableDefinition} to display the options.
*/
@Override
diff --git a/src/main/java/org/apache/commons/cli/help/OptionFormatter.java
b/src/main/java/org/apache/commons/cli/help/OptionFormatter.java
index 4f999c88..8ddc8280 100644
--- a/src/main/java/org/apache/commons/cli/help/OptionFormatter.java
+++ b/src/main/java/org/apache/commons/cli/help/OptionFormatter.java
@@ -112,8 +112,8 @@ public final class OptionFormatter {
/**
* Specifies the starting and ending argument name delimiters for
{@link Option} instances.
*
- * @param begin the beginning delimiter.
- * @param end the ending delimiter.
+ * @param begin The beginning delimiter.
+ * @param end The ending delimiter.
* @return {@code this} instance.
*/
public Builder setArgumentNameDelimiters(final String begin, final
String end) {
@@ -125,7 +125,7 @@ public final class OptionFormatter {
/**
* Sets the default argument name.
*
- * @param name the new value of default argument name.
+ * @param name The new value of default argument name.
* @return {@code this} instance.
*/
public Builder setDefaultArgName(final String name) {
@@ -136,7 +136,7 @@ public final class OptionFormatter {
/**
* Specifies the function to construct the deprecated massage for the
Option. Should include the description text if desired.
*
- * @param deprecatedFormatFunction the function to specify the
deprecated message for the option.
+ * @param deprecatedFormatFunction The function to specify the
deprecated message for the option.
* @return {@code this} instance.
*/
public Builder setDeprecatedFormatFunction(final Function<Option,
String> deprecatedFormatFunction) {
@@ -158,7 +158,7 @@ public final class OptionFormatter {
/**
* Sets the separator displayed between a options and the argument
name. Typically ' ' or '='.
*
- * @param optArgSeparator the separator.
+ * @param optArgSeparator The separator.
* @return {@code this} instance.
* @since 1.3
*/
@@ -170,8 +170,8 @@ public final class OptionFormatter {
/**
* Specifies the starting and ending delimiters for optional {@link
Option} instances.
*
- * @param begin the beginning delimiter.
- * @param end the ending delimiter.
+ * @param begin The beginning delimiter.
+ * @param end The ending delimiter.
* @return {@code this} instance.
*/
public Builder setOptionalDelimiters(final String begin, final String
end) {
@@ -183,7 +183,7 @@ public final class OptionFormatter {
/**
* Specifies the short option prefix.
*
- * @param optPrefix the prefix for short options.
+ * @param optPrefix The prefix for short options.
* @return {@code this} instance.
*/
public Builder setOptPrefix(final String optPrefix) {
@@ -194,7 +194,7 @@ public final class OptionFormatter {
/**
* Sets the separator displayed between a long option and short
options. Typically ',' or ' '.
*
- * @param optSeparator the separator.
+ * @param optSeparator The separator.
* @return {@code this} instance.
* @since 1.3
*/
@@ -217,7 +217,7 @@ public final class OptionFormatter {
/**
* A helper method to format any string as an argument name based on
this builder.
*
- * @param argName the name of the argument.
+ * @param argName The name of the argument.
* @return The formatted argument.
*/
public String toArgName(final String argName) {
@@ -305,7 +305,7 @@ public final class OptionFormatter {
/**
* Construct the {@link OptionFormatter} from an {@link Option} using the
default {@link OptionFormatter.Builder}.
*
- * @param option the option to format.
+ * @param option The option to format.
* @return An OptionFormatter for the specified @{code option}.
*/
public static OptionFormatter from(final Option option) {
@@ -347,7 +347,7 @@ public final class OptionFormatter {
/**
* An OptionFormatter applies formatting options to various {@link Option}
attributes for textual display.
*
- * @param option the Option to apply formatting to.
+ * @param option The Option to apply formatting to.
* @param builder The Builder that specifies the various formatting
options.
*/
private OptionFormatter(final Option option, final Builder builder) {
@@ -449,7 +449,7 @@ public final class OptionFormatter {
/**
* Wraps the provided text in the optional delimiters.
*
- * @param text the text to wrap.
+ * @param text The text to wrap.
* @return The text wrapped in the optional delimiters or an eppty string
of the text is null or an empty string.
*/
public String toOptional(final String text) {
diff --git a/src/main/java/org/apache/commons/cli/help/TableDefinition.java
b/src/main/java/org/apache/commons/cli/help/TableDefinition.java
index 52b08add..ae86f369 100644
--- a/src/main/java/org/apache/commons/cli/help/TableDefinition.java
+++ b/src/main/java/org/apache/commons/cli/help/TableDefinition.java
@@ -39,9 +39,9 @@ public interface TableDefinition {
* A helper function to create a table instance from the various
components.
*
* @param caption The caption, may be {@code null}.
- * @param columnStyle a list of TextStyle elements defining the columns.
- * @param headers the list of column headers.
- * @param rows a collection of rows.
+ * @param columnStyle A list of TextStyle elements defining the columns.
+ * @param headers The list of column headers.
+ * @param rows A collection of rows.
* @return A TableDefinition returning the parameters as appropriate.
*/
static TableDefinition from(final String caption, final List<TextStyle>
columnStyle, final List<String> headers, final Iterable<List<String>> rows) {
diff --git a/src/main/java/org/apache/commons/cli/help/TextHelpAppendable.java
b/src/main/java/org/apache/commons/cli/help/TextHelpAppendable.java
index 74d07ce3..14c90c7c 100644
--- a/src/main/java/org/apache/commons/cli/help/TextHelpAppendable.java
+++ b/src/main/java/org/apache/commons/cli/help/TextHelpAppendable.java
@@ -115,7 +115,7 @@ public class TextHelpAppendable extends
FilterHelpAppendable {
/**
* Constructs an appendable filter built on top of the specified
underlying appendable.
*
- * @param output the underlying appendable to be assigned to the field
{@code this.output} for later use, or {@code null} if this instance is to be
created
+ * @param output The underlying appendable to be assigned to the field
{@code this.output} for later use, or {@code null} if this instance is to be
created
* without an underlying stream.
*/
public TextHelpAppendable(final Appendable output) {
@@ -143,7 +143,7 @@ public class TextHelpAppendable extends
FilterHelpAppendable {
* Note: it is possible for the size of the columns to exceed the declared
page width. In this case the table will extend beyond the desired page width.
* </p>
*
- * @param table the table to adjust.
+ * @param table The table to adjust.
* @return A new TableDefinition with adjusted values.
*/
protected TableDefinition adjustTableFormat(final TableDefinition table) {
@@ -327,7 +327,7 @@ public class TextHelpAppendable extends
FilterHelpAppendable {
* + the left pad.
*
* @param columnData The column data to output.
- * @param styles the styles to apply.
+ * @param styles The styles to apply.
* @return A list of queues of strings that represent each column in the
table.
*/
protected List<Queue<String>> makeColumnQueues(final List<String>
columnData, final List<TextStyle> styles) {
@@ -341,7 +341,7 @@ public class TextHelpAppendable extends
FilterHelpAppendable {
/**
* Prints a queue of text.
*
- * @param queue the queue of text to print.
+ * @param queue The queue of text to print.
* @throws IOException on output error.
*/
private void printQueue(final Queue<String> queue) throws IOException {
@@ -353,7 +353,7 @@ public class TextHelpAppendable extends
FilterHelpAppendable {
/**
* Prints wrapped text using the TextHelpAppendable output style.
*
- * @param text the text to wrap
+ * @param text The text to wrap
* @throws IOException on output error.
*/
public void printWrapped(final String text) throws IOException {
@@ -363,8 +363,8 @@ public class TextHelpAppendable extends
FilterHelpAppendable {
/**
* Prints wrapped text.
*
- * @param text the text to wrap
- * @param style the style for the wrapped text.
+ * @param text The text to wrap
+ * @param style The style for the wrapped text.
* @throws IOException on output error.
*/
public void printWrapped(final String text, final TextStyle style) throws
IOException {
@@ -374,8 +374,8 @@ public class TextHelpAppendable extends
FilterHelpAppendable {
/**
* Resizes an original width based on the fractional size it should be.
*
- * @param orig the original size.
- * @param fraction the fractional adjustment.
+ * @param orig The original size.
+ * @param fraction The fractional adjustment.
* @return The resized value.
*/
private int resize(final int orig, final double fraction) {
@@ -385,8 +385,8 @@ public class TextHelpAppendable extends
FilterHelpAppendable {
/**
* Resizes a TextStyle builder based on the fractional size.
*
- * @param builder the builder to adjust.
- * @param fraction the fractional size (for example percentage of the
current size) that the builder should be.
+ * @param builder The builder to adjust.
+ * @param fraction The fractional size (for example percentage of the
current size) that the builder should be.
* @return The builder with the maximum width and indent values resized.
*/
protected TextStyle.Builder resize(final TextStyle.Builder builder, final
double fraction) {
@@ -404,7 +404,7 @@ public class TextHelpAppendable extends
FilterHelpAppendable {
/**
* Sets the indent for the output.
*
- * @param indent the indent used for paragraphs.
+ * @param indent The indent used for paragraphs.
*/
public void setIndent(final int indent) {
textStyleBuilder.setIndent(indent);
@@ -414,7 +414,7 @@ public class TextHelpAppendable extends
FilterHelpAppendable {
/**
* Sets the left padding: the number of characters from the left edge to
start output.
*
- * @param leftPad the left padding.
+ * @param leftPad The left padding.
*/
public void setLeftPad(final int leftPad) {
textStyleBuilder.setLeftPad(leftPad);
@@ -424,7 +424,7 @@ public class TextHelpAppendable extends
FilterHelpAppendable {
/**
* Sets the maximum width for the output.
*
- * @param maxWidth the maximum width for the output.
+ * @param maxWidth The maximum width for the output.
*/
public void setMaxWidth(final int maxWidth) {
textStyleBuilder.setMaxWidth(maxWidth);
@@ -435,8 +435,8 @@ public class TextHelpAppendable extends
FilterHelpAppendable {
* Writes one line from each of the {@code columnQueues} until all the
queues are exhausted. If an exhausted queue is encountered while other queues
* continue to have content the exhausted queue will produce empty text
for the output width of the column (maximum width + left pad).
*
- * @param columnQueues the List of queues that represent the columns of
data.
- * @param styles the TextStyle for each column.
+ * @param columnQueues The List of queues that represent the columns of
data.
+ * @param styles The TextStyle for each column.
* @throws IOException on output error.
*/
protected void writeColumnQueues(final List<Queue<String>> columnQueues,
final List<TextStyle> styles) throws IOException {
diff --git a/src/main/java/org/apache/commons/cli/help/TextStyle.java
b/src/main/java/org/apache/commons/cli/help/TextStyle.java
index e76b600a..fef720f3 100644
--- a/src/main/java/org/apache/commons/cli/help/TextStyle.java
+++ b/src/main/java/org/apache/commons/cli/help/TextStyle.java
@@ -144,7 +144,7 @@ public final class TextStyle {
/**
* Sets the alignment.
*
- * @param alignment the desired alignment.
+ * @param alignment The desired alignment.
* @return {@code this} instance.
*/
public Builder setAlignment(final Alignment alignment) {
@@ -155,7 +155,7 @@ public final class TextStyle {
/**
* Sets the indent value.
*
- * @param indent the new indent value.
+ * @param indent The new indent value.
* @return {@code this} instance.
*/
public Builder setIndent(final int indent) {
@@ -166,7 +166,7 @@ public final class TextStyle {
/**
* Sets the left padding.
*
- * @param leftPad the new left padding.
+ * @param leftPad The new left padding.
* @return {@code this} instance.
*/
public Builder setLeftPad(final int leftPad) {
@@ -210,7 +210,7 @@ public final class TextStyle {
/**
* Sets all properties from the given text style.
*
- * @param style the source text style.
+ * @param style The source text style.
* @return {@code this} instance.
*/
public Builder setTextStyle(final TextStyle style) {
@@ -265,7 +265,7 @@ public final class TextStyle {
/**
* Constructs a new instance.
*
- * @param builder the builder to build the text style from.
+ * @param builder The builder to build the text style from.
*/
private TextStyle(final Builder builder) {
this.alignment = builder.alignment;
@@ -338,7 +338,7 @@ public final class TextStyle {
* </ul>
*
* @param addIndent if {@code true} account for the indent when padding
the string.
- * @param text the text to pad.
+ * @param text The text to pad.
* @return The padded string.
*/
public CharSequence pad(final boolean addIndent, final CharSequence text) {
diff --git a/src/main/java/org/apache/commons/cli/help/Util.java
b/src/main/java/org/apache/commons/cli/help/Util.java
index e51e286b..76d584f3 100644
--- a/src/main/java/org/apache/commons/cli/help/Util.java
+++ b/src/main/java/org/apache/commons/cli/help/Util.java
@@ -33,7 +33,7 @@ final class Util {
* Returns the {@code defaultValue} if {@code str} is empty.
*
* @param str The string to check.
- * @param defaultValue the default value if the string is empty.
+ * @param defaultValue The default value if the string is empty.
* @param <T> The type of arguments.
* @return The {@code defaultValue} if {@code str} is empty,
*/
@@ -44,8 +44,8 @@ final class Util {
/**
* Finds the index of the first non whitespace character.
*
- * @param text the text to search in.
- * @param startPos the starting position to search from.
+ * @param text The text to search in.
+ * @param startPos The starting position to search from.
* @return The index of the first non whitespace character or -1 if non
found.
*/
static int indexOfNonWhitespace(final CharSequence text, final int
startPos) {
@@ -93,8 +93,8 @@ final class Util {
/**
* Constructs a string of specified length filled with the specified char.
*
- * @param len the length of the final string.
- * @param fillChar the character to file it will.
+ * @param len The length of the final string.
+ * @param fillChar The character to file it will.
* @return A string of specified length filled with the specified char.
*/
static String repeat(final int len, final char fillChar) {
diff --git a/src/test/java/org/apache/commons/cli/CommandLineTest.java
b/src/test/java/org/apache/commons/cli/CommandLineTest.java
index 6de605a5..98c7eb79 100644
--- a/src/test/java/org/apache/commons/cli/CommandLineTest.java
+++ b/src/test/java/org/apache/commons/cli/CommandLineTest.java
@@ -374,14 +374,14 @@ class CommandLineTest {
/**
* Test for get option value with and without default values. Verifies
that deprecated options only report as
* deprecated once.
- * @param args the argument strings to parse.
- * @param opt the option to check for values with.
- * @param optionGroup the option group to check for values with.
+ * @param args The argument strings to parse.
+ * @param opt The option to check for values with.
+ * @param optionGroup The option group to check for values with.
* @param optDep {@code true} if the opt is deprecated.
* @param optValue The value expected from opt.
* @param grpDep {@code true} if the group is deprecated.
- * @param grpValue the value expected from the group.
- * @param grpOpt the option that is expected to be processed by the group.
+ * @param grpValue The value expected from the group.
+ * @param grpOpt The option that is expected to be processed by the group.
* @throws ParseException on parse error.
*/
@ParameterizedTest(name = "{0}, {1}")
@@ -480,14 +480,14 @@ class CommandLineTest {
/**
* Test for get option values with and without default values. Verifies
that deprecated options only report as
* deprecated once.
- * @param args the argument strings to parse.
- * @param opt the option to check for values with.
- * @param optionGroup the option group to check for values with.
+ * @param args The argument strings to parse.
+ * @param opt The option to check for values with.
+ * @param optionGroup The option group to check for values with.
* @param optDep {@code true} if the opt is deprecated.
* @param optValue The value expected from opt.
* @param grpDep {@code true} if the group is deprecated.
- * @param grpValue the value expected from the group.
- * @param grpOpt the option that is expected to be processed by the group.
+ * @param grpValue The value expected from the group.
+ * @param grpOpt The option that is expected to be processed by the group.
* @throws ParseException on parse error.
*/
@ParameterizedTest(name = "{0}, {1}")
@@ -724,14 +724,14 @@ class CommandLineTest {
/**
* Tests the hasOption calls.
- * @param args the argument strings to parse.
- * @param opt the option to check for values with.
- * @param optionGroup the option group to check for values with.
+ * @param args The argument strings to parse.
+ * @param opt The option to check for values with.
+ * @param optionGroup The option group to check for values with.
* @param optDep {@code true} if the opt is deprecated.
* @param has {@code true} if the opt is present.
* @param grpDep {@code true} if the group is deprecated.
* @param hasGrp {@code true} if the group is present.
- * @param grpOpt the option that is expected to be processed by the group.
+ * @param grpOpt The option that is expected to be processed by the group.
* @throws ParseException on parsing error.
*/
@ParameterizedTest(name = "{0}, {1}")
@@ -780,14 +780,14 @@ class CommandLineTest {
/**
* Tests the hasOption calls.
- * @param args the argument strings to parse.
- * @param opt the option to check for values with.
- * @param optionGroup the option group to check for values with.
+ * @param args The argument strings to parse.
+ * @param opt The option to check for values with.
+ * @param optionGroup The option group to check for values with.
* @param optDep {@code true} if the opt is deprecated.
* @param has {@code true} if the opt is present.
* @param grpDep {@code true} if the group is deprecated.
* @param hasGrp {@code true} if the group is present.
- * @param grpOpt the option that is expected to be processed by the group.
+ * @param grpOpt The option that is expected to be processed by the group.
* @throws ParseException on parsing error.
*/
@ParameterizedTest(name = "{0}, {1}")
@@ -831,14 +831,14 @@ class CommandLineTest {
/**
* Tests the hasOption calls.
- * @param args the argument strings to parse.
- * @param opt the option to check for values with.
- * @param optionGroup the option group to check for values with.
+ * @param args The argument strings to parse.
+ * @param opt The option to check for values with.
+ * @param optionGroup The option group to check for values with.
* @param optDep {@code true} if the opt is deprecated.
* @param has {@code true} if the opt is present.
* @param grpDep {@code true} if the group is deprecated.
* @param hasGrp {@code true} if the group is present.
- * @param grpOpt the option that is expected to be processed by the group.
+ * @param grpOpt The option that is expected to be processed by the group.
* @throws ParseException on parsing error.
*/
@ParameterizedTest(name = "{0}, {1}")
diff --git
a/src/test/java/org/apache/commons/cli/example/AptHelpAppendable.java
b/src/test/java/org/apache/commons/cli/example/AptHelpAppendable.java
index cbedfe22..db335e09 100644
--- a/src/test/java/org/apache/commons/cli/example/AptHelpAppendable.java
+++ b/src/test/java/org/apache/commons/cli/example/AptHelpAppendable.java
@@ -51,7 +51,7 @@ public class AptHelpAppendable extends FilterHelpAppendable {
/**
* Constructs an appendable filter built on top of the specified
underlying appendable.
*
- * @param output the underlying appendable to be assigned to the field
{@code this.output} for later use, or {@code null} if this instance is to be
created
+ * @param output The underlying appendable to be assigned to the field
{@code this.output} for later use, or {@code null} if this instance is to be
created
* without an underlying stream.
*/
public AptHelpAppendable(final Appendable output) {
diff --git
a/src/test/java/org/apache/commons/cli/example/XhtmlHelpAppendable.java
b/src/test/java/org/apache/commons/cli/example/XhtmlHelpAppendable.java
index 51ae058d..00f901ab 100644
--- a/src/test/java/org/apache/commons/cli/example/XhtmlHelpAppendable.java
+++ b/src/test/java/org/apache/commons/cli/example/XhtmlHelpAppendable.java
@@ -34,7 +34,7 @@ public class XhtmlHelpAppendable extends FilterHelpAppendable
{
/**
* Constructs an appendable filter built on top of the specified
underlying appendable.
*
- * @param output the underlying appendable to be assigned to the field
{@code this.output} for later use, or {@code null} if this instance is to be
created
+ * @param output The underlying appendable to be assigned to the field
{@code this.output} for later use, or {@code null} if this instance is to be
created
* without an underlying stream.
*/
public XhtmlHelpAppendable(final Appendable output) {
