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 a59c44b8 Javadoc
a59c44b8 is described below
commit a59c44b8f334f2b2fe7076807258ebc1e21a2f31
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 08:22:25 2026 -0400
Javadoc
---
.../commons/cli/AlreadySelectedException.java | 4 +-
.../java/org/apache/commons/cli/CommandLine.java | 54 +++++++++++-----------
.../org/apache/commons/cli/CommandLineParser.java | 4 +-
.../java/org/apache/commons/cli/Converter.java | 2 +-
.../java/org/apache/commons/cli/DefaultParser.java | 12 ++---
.../apache/commons/cli/DeprecatedAttributes.java | 4 +-
.../java/org/apache/commons/cli/HelpFormatter.java | 30 ++++++------
.../commons/cli/MissingArgumentException.java | 2 +-
.../apache/commons/cli/MissingOptionException.java | 2 +-
src/main/java/org/apache/commons/cli/Option.java | 28 +++++------
.../java/org/apache/commons/cli/OptionBuilder.java | 38 +++++++--------
.../java/org/apache/commons/cli/OptionGroup.java | 8 ++--
src/main/java/org/apache/commons/cli/Options.java | 20 ++++----
.../org/apache/commons/cli/ParseException.java | 2 +-
src/main/java/org/apache/commons/cli/Parser.java | 12 ++---
.../java/org/apache/commons/cli/TypeHandler.java | 8 ++--
.../commons/cli/UnrecognizedOptionException.java | 2 +-
src/main/java/org/apache/commons/cli/Util.java | 4 +-
.../commons/cli/help/AbstractHelpFormatter.java | 20 ++++----
.../apache/commons/cli/help/OptionFormatter.java | 6 +--
.../apache/commons/cli/help/TableDefinition.java | 2 +-
.../commons/cli/help/TextHelpAppendable.java | 8 ++--
.../org/apache/commons/cli/help/TextStyle.java | 10 ++--
.../java/org/apache/commons/cli/help/Util.java | 4 +-
24 files changed, 143 insertions(+), 143 deletions(-)
diff --git a/src/main/java/org/apache/commons/cli/AlreadySelectedException.java
b/src/main/java/org/apache/commons/cli/AlreadySelectedException.java
index 7603eac5..1bcbf6f0 100644
--- a/src/main/java/org/apache/commons/cli/AlreadySelectedException.java
+++ b/src/main/java/org/apache/commons/cli/AlreadySelectedException.java
@@ -63,7 +63,7 @@ public class AlreadySelectedException extends ParseException {
/**
* Gets the option that was added to the group and triggered the exception.
*
- * @return the related option.
+ * @return The related option.
* @since 1.2
*/
public Option getOption() {
@@ -73,7 +73,7 @@ public class AlreadySelectedException extends ParseException {
/**
* Gets the option group where another option has been selected.
*
- * @return the related option group.
+ * @return The related option group.
* @since 1.2
*/
public OptionGroup getOptionGroup() {
diff --git a/src/main/java/org/apache/commons/cli/CommandLine.java
b/src/main/java/org/apache/commons/cli/CommandLine.java
index d0ca1fc5..2d3c7ac3 100644
--- a/src/main/java/org/apache/commons/cli/CommandLine.java
+++ b/src/main/java/org/apache/commons/cli/CommandLine.java
@@ -203,7 +203,7 @@ public class CommandLine implements Serializable {
* Gets the first element or null if values is null.
*
* @param values the array to query.
- * @return the first element or null if values is null.
+ * @return The first element or null if values is null.
*/
private String first(final String[] values) {
return values == null ? null : values[0];
@@ -268,7 +268,7 @@ public class CommandLine implements Serializable {
* Gets the {@code Object} type of this {@code Option}.
*
* @param optionChar the name of the option.
- * @return the type of opt.
+ * @return The type of opt.
* @deprecated due to System.err message; use {@link
#getParsedOptionValue(char)} instead.
*/
@Deprecated
@@ -280,7 +280,7 @@ public class CommandLine implements Serializable {
* Gets the {@code Object} type of this {@code Option}.
*
* @param optionName the name of the option.
- * @return the type of this {@code Option}.
+ * @return The type of this {@code Option}.
* @deprecated due to System.err message; use {@link
#getParsedOptionValue(String)} instead.
*/
@Deprecated
@@ -543,7 +543,7 @@ public class CommandLine implements Serializable {
*
* @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.
+ * @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.
* @see PatternOptionBuilder
* @since 1.5.0
@@ -558,7 +558,7 @@ public class CommandLine implements Serializable {
* @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.
+ * @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.
* @see PatternOptionBuilder
* @since 1.7.0
@@ -573,7 +573,7 @@ public class CommandLine implements Serializable {
* @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.
+ * @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.
* @see PatternOptionBuilder
* @since 1.7.0
@@ -587,7 +587,7 @@ public class CommandLine implements Serializable {
*
* @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.
+ * @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.
* @see PatternOptionBuilder
* @since 1.5.0
@@ -602,7 +602,7 @@ public class CommandLine implements Serializable {
* @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.
+ * @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.
* @see PatternOptionBuilder
* @since 1.7.0
@@ -629,7 +629,7 @@ public class CommandLine implements Serializable {
* @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.
+ * @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.
* @see PatternOptionBuilder
* @since 1.7.0
@@ -643,7 +643,7 @@ public class CommandLine implements Serializable {
*
* @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.
+ * @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.
* @see PatternOptionBuilder
* @since 1.9.0
@@ -658,7 +658,7 @@ public class CommandLine implements Serializable {
* @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.
+ * @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.
* @see PatternOptionBuilder
* @since 1.9.0
@@ -676,7 +676,7 @@ public class CommandLine implements Serializable {
* @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.
+ * @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.
* @see PatternOptionBuilder
* @since 1.9.0
@@ -690,7 +690,7 @@ public class CommandLine implements Serializable {
*
* @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.
+ * @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.
* @see PatternOptionBuilder
* @since 1.2
@@ -705,7 +705,7 @@ public class CommandLine implements Serializable {
* @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.
+ * @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.
* @see PatternOptionBuilder
* @since 1.7.0
@@ -720,7 +720,7 @@ public class CommandLine implements Serializable {
* @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.
+ * @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.
* @see PatternOptionBuilder
* @since 1.7.0
@@ -734,7 +734,7 @@ public class CommandLine implements Serializable {
*
* @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.
+ * @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.
* @see PatternOptionBuilder
* @since 1.10.0
@@ -749,7 +749,7 @@ public class CommandLine implements Serializable {
* @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.
+ * @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.
* @see PatternOptionBuilder
* @since 1.10.0
@@ -764,7 +764,7 @@ public class CommandLine implements Serializable {
* @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.
+ * @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.
* @see PatternOptionBuilder
* @since 1.10.0
@@ -778,7 +778,7 @@ public class CommandLine implements Serializable {
*
* @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.
+ * @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.
* @see PatternOptionBuilder
* @since 1.10.0
@@ -793,7 +793,7 @@ public class CommandLine implements Serializable {
* @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.
+ * @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.
* @see PatternOptionBuilder
* @since 1.10.0
@@ -825,7 +825,7 @@ public class CommandLine implements Serializable {
* @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.
+ * @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.
* @see PatternOptionBuilder
* @since 1.10.0
@@ -839,7 +839,7 @@ public class CommandLine implements Serializable {
*
* @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.
+ * @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.
* @see PatternOptionBuilder
* @since 1.10.0
@@ -854,7 +854,7 @@ public class CommandLine implements Serializable {
* @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.
+ * @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.
* @see PatternOptionBuilder
* @since 1.10.0
@@ -872,7 +872,7 @@ public class CommandLine implements Serializable {
* @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.
+ * @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.
* @see PatternOptionBuilder
* @since 1.10.0
@@ -886,7 +886,7 @@ public class CommandLine implements Serializable {
*
* @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.
+ * @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.
* @see PatternOptionBuilder
* @since 1.10.0
@@ -901,7 +901,7 @@ public class CommandLine implements Serializable {
* @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.
+ * @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.
* @see PatternOptionBuilder
* @since 1.10.0
@@ -916,7 +916,7 @@ public class CommandLine implements Serializable {
* @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.
+ * @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.
* @see PatternOptionBuilder
* @since 1.10.0
diff --git a/src/main/java/org/apache/commons/cli/CommandLineParser.java
b/src/main/java/org/apache/commons/cli/CommandLineParser.java
index fb35630d..125597a5 100644
--- a/src/main/java/org/apache/commons/cli/CommandLineParser.java
+++ b/src/main/java/org/apache/commons/cli/CommandLineParser.java
@@ -28,7 +28,7 @@ public interface CommandLineParser {
*
* @param options the specified Options.
* @param arguments the command line arguments.
- * @return the list of atomic option and value tokens.
+ * @return The list of atomic option and value tokens.
* @throws ParseException if there are any problems encountered while
parsing the command line tokens.
*/
CommandLine parse(Options options, String[] arguments) throws
ParseException;
@@ -42,7 +42,7 @@ public interface CommandLineParser {
* are added to the {@link CommandLine}s args list. If {@code
false} an unrecognized argument triggers a
* ParseException.
*
- * @return the list of atomic option and value tokens.
+ * @return The list of atomic option and value tokens.
* @throws ParseException if there are any problems encountered while
parsing the command line tokens.
*/
CommandLine parse(Options options, String[] arguments, boolean
stopAtNonOption) throws ParseException;
diff --git a/src/main/java/org/apache/commons/cli/Converter.java
b/src/main/java/org/apache/commons/cli/Converter.java
index bc121283..844d485b 100644
--- a/src/main/java/org/apache/commons/cli/Converter.java
+++ b/src/main/java/org/apache/commons/cli/Converter.java
@@ -92,7 +92,7 @@ public interface Converter<T, E extends Exception> {
* Applies the conversion function to the String argument.
*
* @param string the String to convert.
- * @return the Object from the conversion.
+ * @return The Object from the conversion.
* @throws E on error.
*/
T apply(String string) throws E;
diff --git a/src/main/java/org/apache/commons/cli/DefaultParser.java
b/src/main/java/org/apache/commons/cli/DefaultParser.java
index 63700983..801a989e 100644
--- a/src/main/java/org/apache/commons/cli/DefaultParser.java
+++ b/src/main/java/org/apache/commons/cli/DefaultParser.java
@@ -76,7 +76,7 @@ public class DefaultParser implements CommandLineParser {
/**
* Builds an DefaultParser with the values declared by this {@link
Builder}.
*
- * @return the new {@link DefaultParser}.
+ * @return The new {@link DefaultParser}.
* @since 1.5.0
* @deprecated Use {@link #get()}.
*/
@@ -88,7 +88,7 @@ public class DefaultParser implements CommandLineParser {
/**
* Builds an DefaultParser with the values declared by this {@link
Builder}.
*
- * @return the new {@link DefaultParser}.
+ * @return The new {@link DefaultParser}.
* @since 1.10.0
*/
@Override
@@ -372,7 +372,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).
- * @return the list of matching option strings or an empty list if no
matching option could be found.
+ * @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) {
if (allowPartialMatching) {
@@ -747,7 +747,7 @@ public class DefaultParser implements CommandLineParser {
* @param nonOptionAction see {@link NonOptionAction}.
* @param arguments the command line arguments
*
- * @return the list of atomic option and value tokens.
+ * @return The list of atomic option and value tokens.
* @throws ParseException if there are any problems encountered while
parsing the command line tokens.
* @since 1.10.0
*/
@@ -795,7 +795,7 @@ public class DefaultParser implements CommandLineParser {
* @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.
+ * @return The list of atomic option and value tokens.
* @throws ParseException if there are any problems encountered while
parsing the command line tokens.
*/
public CommandLine parse(final Options options, final String[] arguments,
final Properties properties) throws ParseException {
@@ -811,7 +811,7 @@ public class DefaultParser implements CommandLineParser {
* @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.
- * @return the list of atomic option and value tokens.
+ * @return The list of atomic option and value tokens.
* @throws ParseException if there are any problems encountered while
parsing the command line tokens.
* @see #parse(Options, Properties, NonOptionAction, String[])
*/
diff --git a/src/main/java/org/apache/commons/cli/DeprecatedAttributes.java
b/src/main/java/org/apache/commons/cli/DeprecatedAttributes.java
index b4ec5f35..50dc344a 100644
--- a/src/main/java/org/apache/commons/cli/DeprecatedAttributes.java
+++ b/src/main/java/org/apache/commons/cli/DeprecatedAttributes.java
@@ -149,7 +149,7 @@ public final class DeprecatedAttributes {
/**
* Gets the descriptions.
*
- * @return the descriptions.
+ * @return The descriptions.
*/
public String getDescription() {
return description;
@@ -158,7 +158,7 @@ public final class DeprecatedAttributes {
/**
* Gets version in which the option became deprecated.
*
- * @return the version in which the option became deprecated.
+ * @return The version in which the option became deprecated.
*/
public String getSince() {
return since;
diff --git a/src/main/java/org/apache/commons/cli/HelpFormatter.java
b/src/main/java/org/apache/commons/cli/HelpFormatter.java
index 8873adda..48991609 100644
--- a/src/main/java/org/apache/commons/cli/HelpFormatter.java
+++ b/src/main/java/org/apache/commons/cli/HelpFormatter.java
@@ -236,7 +236,7 @@ public class HelpFormatter {
* Gets the option description or an empty string if the description is
{@code null}.
*
* @param option The option to get the description from.
- * @return the option description or an empty string if the description is
{@code null}.
+ * @return The option description or an empty string if the description is
{@code null}.
* @since 1.8.0
*/
public static String getDescription(final Option option) {
@@ -417,7 +417,7 @@ public class HelpFormatter {
* @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
- * @return the StringBuffer with the rendered Options contents.
+ * @return The StringBuffer with the rendered Options contents.
* @throws IOException if an I/O error occurs.
*/
<A extends Appendable> A appendOptions(final A sb, final int width, final
Options options, final int leftPad, final int descPad) throws IOException {
@@ -501,7 +501,7 @@ public class HelpFormatter {
* @param width The number of characters to display per line
* @param nextLineTabStop The position on the next line for the first tab.
* @param text The text to be rendered.
- * @return the StringBuffer with the rendered Options contents.
+ * @return The StringBuffer with the rendered Options contents.
* @throws IOException if an I/O error occurs.
*/
<A extends Appendable> A appendWrappedText(final A appendable, final int
width, final int nextLineTabStop, final String text) throws IOException {
@@ -596,7 +596,7 @@ public class HelpFormatter {
/**
* Gets the 'argName'.
*
- * @return the 'argName'
+ * @return The 'argName'
*/
public String getArgName() {
return defaultArgName;
@@ -605,7 +605,7 @@ public class HelpFormatter {
/**
* Gets the 'descPadding'.
*
- * @return the 'descPadding'
+ * @return The 'descPadding'
*/
public int getDescPadding() {
return defaultDescPad;
@@ -614,7 +614,7 @@ public class HelpFormatter {
/**
* Gets the 'leftPadding'.
*
- * @return the 'leftPadding'
+ * @return The 'leftPadding'
*/
public int getLeftPadding() {
return defaultLeftPad;
@@ -623,7 +623,7 @@ public class HelpFormatter {
/**
* Gets the 'longOptPrefix'.
*
- * @return the 'longOptPrefix'
+ * @return The 'longOptPrefix'
*/
public String getLongOptPrefix() {
return defaultLongOptPrefix;
@@ -632,7 +632,7 @@ public class HelpFormatter {
/**
* Gets the separator displayed between a long option and its value.
*
- * @return the separator
+ * @return The separator
* @since 1.3
*/
public String getLongOptSeparator() {
@@ -642,7 +642,7 @@ public class HelpFormatter {
/**
* Gets the 'newLine'.
*
- * @return the 'newLine'
+ * @return The 'newLine'
*/
public String getNewLine() {
return defaultNewLine;
@@ -652,7 +652,7 @@ public class HelpFormatter {
* Comparator used to sort the options when they output in help text.
Defaults to case-insensitive alphabetical sorting
* by option key.
*
- * @return the {@link Comparator} currently in use to sort the options
+ * @return The {@link Comparator} currently in use to sort the options
* @since 1.2
*/
public Comparator<Option> getOptionComparator() {
@@ -662,7 +662,7 @@ public class HelpFormatter {
/**
* Gets the 'optPrefix'.
*
- * @return the 'optPrefix'
+ * @return The 'optPrefix'
*/
public String getOptPrefix() {
return defaultOptPrefix;
@@ -671,7 +671,7 @@ public class HelpFormatter {
/**
* Gets the 'syntaxPrefix'.
*
- * @return the 'syntaxPrefix'
+ * @return The 'syntaxPrefix'
*/
public String getSyntaxPrefix() {
return defaultSyntaxPrefix;
@@ -680,7 +680,7 @@ public class HelpFormatter {
/**
* Gets the 'width'.
*
- * @return the 'width'
+ * @return The 'width'
*/
public int getWidth() {
return defaultWidth;
@@ -929,7 +929,7 @@ public class HelpFormatter {
* @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
- * @return the StringBuffer with the rendered Options contents.
+ * @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) {
try {
@@ -947,7 +947,7 @@ public class HelpFormatter {
* @param width The number of characters to display per line
* @param nextLineTabStop The position on the next line for the first tab.
* @param text The text to be rendered.
- * @return the StringBuffer with the rendered Options contents.
+ * @return The StringBuffer with the rendered Options contents.
*/
protected StringBuffer renderWrappedText(final StringBuffer sb, final int
width, final int nextLineTabStop, final String text) {
try {
diff --git a/src/main/java/org/apache/commons/cli/MissingArgumentException.java
b/src/main/java/org/apache/commons/cli/MissingArgumentException.java
index adb0e42e..95ef6da3 100644
--- a/src/main/java/org/apache/commons/cli/MissingArgumentException.java
+++ b/src/main/java/org/apache/commons/cli/MissingArgumentException.java
@@ -53,7 +53,7 @@ public class MissingArgumentException extends ParseException {
/**
* Gets the option requiring an argument that wasn't provided on the
command line.
*
- * @return the related option
+ * @return The related option
* @since 1.2
*/
public Option getOption() {
diff --git a/src/main/java/org/apache/commons/cli/MissingOptionException.java
b/src/main/java/org/apache/commons/cli/MissingOptionException.java
index 7ab19656..40f6c068 100644
--- a/src/main/java/org/apache/commons/cli/MissingOptionException.java
+++ b/src/main/java/org/apache/commons/cli/MissingOptionException.java
@@ -65,7 +65,7 @@ public class MissingOptionException extends ParseException {
/**
* Gets the list of options or option groups missing in the command line
parsed.
*
- * @return the missing options, consisting of String instances for simple
options, and OptionGroup instances for
+ * @return The missing options, consisting of String instances for simple
options, and OptionGroup instances for
* required option groups.
* @since 1.2
*/
diff --git a/src/main/java/org/apache/commons/cli/Option.java
b/src/main/java/org/apache/commons/cli/Option.java
index 61436992..5cb44213 100644
--- a/src/main/java/org/apache/commons/cli/Option.java
+++ b/src/main/java/org/apache/commons/cli/Option.java
@@ -61,7 +61,7 @@ public class Option implements Cloneable, Serializable {
* Returns the input Class or the default type (String) if null.
*
* @param type the candidate Class.
- * @return the input Class or the default type (String) if null.
+ * @return The input Class or the default type (String) if null.
*/
private static Class<?> toType(final Class<?> type) {
return type != null ? type : DEFAULT_TYPE;
@@ -127,7 +127,7 @@ public class Option implements Cloneable, Serializable {
/**
* Constructs an Option with the values declared by this {@link
Builder}.
*
- * @return the new {@link Option}.
+ * @return The new {@link Option}.
* @throws IllegalArgumentException if neither {@code opt} or {@code
longOpt} has been set.
* @deprecated Use {@link #get()}.
*/
@@ -187,7 +187,7 @@ public class Option implements Cloneable, Serializable {
/**
* Constructs an Option with the values declared by this {@link
Builder}.
*
- * @return the new {@link Option}.
+ * @return The new {@link Option}.
* @throws IllegalStateException if neither {@code opt} or {@code
longOpt} has been set.
*/
@Override
@@ -579,7 +579,7 @@ public class Option implements Cloneable, Serializable {
/**
* Gets the display name for the argument value.
*
- * @return the display name for the argument value.
+ * @return The display name for the argument value.
*/
public String getArgName() {
return argName;
@@ -604,7 +604,7 @@ public class Option implements Cloneable, Serializable {
/**
* Gets the value to type converter.
*
- * @return the value to type converter.
+ * @return The value to type converter.
* @since 1.7.0
*/
public Converter<?, ?> getConverter() {
@@ -633,7 +633,7 @@ public class Option implements Cloneable, Serializable {
/**
* Gets the id of this Option. This is only set when the Option shortOpt
is a single character. This is used for switch statements.
*
- * @return the id of this Option.
+ * @return The id of this Option.
*/
public int getId() {
return getKey().charAt(0);
@@ -642,7 +642,7 @@ public class Option implements Cloneable, Serializable {
/**
* Gets the 'unique' Option identifier. This is the option value if set or
the long value if the options value is not set.
*
- * @return the 'unique' Option identifier.
+ * @return The 'unique' Option identifier.
* @since 1.7.0
*/
public String getKey() {
@@ -674,7 +674,7 @@ public class Option implements Cloneable, Serializable {
/**
* Gets the version when this option was added.
*
- * @return the version when this option was added, or {@code null} if not
set.
+ * @return The version when this option was added, or {@code null} if not
set.
*/
public String getSince() {
return since;
@@ -692,7 +692,7 @@ public class Option implements Cloneable, Serializable {
/**
* Gets the specified value of this Option or {@code null} if there is no
value.
*
- * @return the value/first value of this Option or {@code null} if there
is no value.
+ * @return The value/first value of this Option or {@code null} if there
is no value.
*/
public String getValue() {
return isValuesEmpty() ? null : values.get(0);
@@ -702,7 +702,7 @@ public class Option implements Cloneable, Serializable {
* Gets the specified value of this Option or {@code null} if there is no
value.
*
* @param index The index of the value to be returned.
- * @return the specified value of this Option or {@code null} if there is
no value.
+ * @return The specified value of this Option or {@code null} if there is
no value.
* @throws IndexOutOfBoundsException if index is less than 1 or greater
than the number of the values for this Option.
*/
public String getValue(final int index) throws IndexOutOfBoundsException {
@@ -713,7 +713,7 @@ public class Option implements Cloneable, Serializable {
* Gets the value/first value of this Option or the {@code defaultValue}
if there is no value.
*
* @param defaultValue The value to be returned if there is no value.
- * @return the value/first value of this Option or the {@code
defaultValue} if there are no values.
+ * @return The value/first value of this Option or the {@code
defaultValue} if there are no values.
*/
public String getValue(final String defaultValue) {
final String value = getValue();
@@ -723,7 +723,7 @@ public class Option implements Cloneable, Serializable {
/**
* Gets the values of this Option as a String array or an empty array if
there are no values.
*
- * @return the values of this Option as a String array or an empty array
if there are no values.
+ * @return The values of this Option as a String array or an empty array
if there are no values.
*/
public String[] getValues() {
return isValuesEmpty() ? null : values.toArray(EMPTY_STRING_ARRAY);
@@ -732,7 +732,7 @@ public class Option implements Cloneable, Serializable {
/**
* Gets the value separator character.
*
- * @return the value separator character.
+ * @return The value separator character.
*/
public char getValueSeparator() {
return valueSeparator;
@@ -741,7 +741,7 @@ public class Option implements Cloneable, Serializable {
/**
* Gets the values of this Option as a List. Will return an empty list if
there are no values.
*
- * @return the values of this Option as a List or an empty List if there
are no values.
+ * @return The values of this Option as a List or an empty List if there
are no values.
*/
public List<String> getValuesList() {
return values;
diff --git a/src/main/java/org/apache/commons/cli/OptionBuilder.java
b/src/main/java/org/apache/commons/cli/OptionBuilder.java
index 8b6ff0a9..c97d8468 100644
--- a/src/main/java/org/apache/commons/cli/OptionBuilder.java
+++ b/src/main/java/org/apache/commons/cli/OptionBuilder.java
@@ -66,7 +66,7 @@ public final class OptionBuilder {
/**
* Creates an Option using the current settings.
*
- * @return the Option instance.
+ * @return The Option instance.
* @throws IllegalArgumentException if {@code longOpt} has not been set.
*/
public static Option create() throws IllegalArgumentException {
@@ -81,7 +81,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.
- * @return the Option instance.
+ * @return The Option instance.
* @throws IllegalArgumentException if {@code opt} is not a valid
character. See Option.
*/
public static Option create(final char opt) throws
IllegalArgumentException {
@@ -92,7 +92,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.
- * @return the Option instance.
+ * @return The Option instance.
* @throws IllegalArgumentException if {@code opt} is not a valid
character. See Option.
*/
public static Option create(final String opt) throws
IllegalArgumentException {
@@ -120,7 +120,7 @@ public final class OptionBuilder {
/**
* The next Option created will require an argument value.
*
- * @return the OptionBuilder instance
+ * @return The OptionBuilder instance
*/
public static OptionBuilder hasArg() {
argCount = 1;
@@ -131,7 +131,7 @@ public final class OptionBuilder {
* The next Option created will require an argument value if {@code
hasArg} is true.
*
* @param hasArg if true then the Option has an argument value.
- * @return the OptionBuilder instance.
+ * @return The OptionBuilder instance.
*/
public static OptionBuilder hasArg(final boolean hasArg) {
argCount = hasArg ? 1 : Option.UNINITIALIZED;
@@ -141,7 +141,7 @@ public final class OptionBuilder {
/**
* The next Option created can have unlimited argument values.
*
- * @return the OptionBuilder instance.
+ * @return The OptionBuilder instance.
*/
public static OptionBuilder hasArgs() {
argCount = Option.UNLIMITED_VALUES;
@@ -152,7 +152,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.
- * @return the OptionBuilder instance.
+ * @return The OptionBuilder instance.
*/
public static OptionBuilder hasArgs(final int num) {
argCount = num;
@@ -162,7 +162,7 @@ public final class OptionBuilder {
/**
* The next Option can have an optional argument.
*
- * @return the OptionBuilder instance.
+ * @return The OptionBuilder instance.
*/
public static OptionBuilder hasOptionalArg() {
argCount = 1;
@@ -173,7 +173,7 @@ public final class OptionBuilder {
/**
* The next Option can have an unlimited number of optional arguments.
*
- * @return the OptionBuilder instance.
+ * @return The OptionBuilder instance.
*/
public static OptionBuilder hasOptionalArgs() {
argCount = Option.UNLIMITED_VALUES;
@@ -185,7 +185,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.
- * @return the OptionBuilder instance.
+ * @return The OptionBuilder instance.
*/
public static OptionBuilder hasOptionalArgs(final int numArgs) {
argCount = numArgs;
@@ -196,7 +196,7 @@ public final class OptionBuilder {
/**
* The next Option created will be required.
*
- * @return the OptionBuilder instance.
+ * @return The OptionBuilder instance.
*/
public static OptionBuilder isRequired() {
required = true;
@@ -207,7 +207,7 @@ public final class OptionBuilder {
* The next Option created will be required if {@code required} is true.
*
* @param newRequired if true then the Option is required.
- * @return the OptionBuilder instance.
+ * @return The OptionBuilder instance.
*/
public static OptionBuilder isRequired(final boolean newRequired) {
required = newRequired;
@@ -232,7 +232,7 @@ public final class OptionBuilder {
* The next Option created will have the specified argument value name.
*
* @param name the name for the argument value.
- * @return the OptionBuilder instance.
+ * @return The OptionBuilder instance.
*/
public static OptionBuilder withArgName(final String name) {
argName = name;
@@ -243,7 +243,7 @@ public final class OptionBuilder {
* The next Option created will have the specified description
*
* @param newDescription a description of the Option's purpose.
- * @return the OptionBuilder instance.
+ * @return The OptionBuilder instance.
*/
public static OptionBuilder withDescription(final String newDescription) {
description = newDescription;
@@ -254,7 +254,7 @@ public final class OptionBuilder {
* The next Option created will have the following long option value.
*
* @param newLongopt the long option value.
- * @return the OptionBuilder instance.
+ * @return The OptionBuilder instance.
*/
public static OptionBuilder withLongOpt(final String newLongopt) {
longOption = newLongopt;
@@ -265,7 +265,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.
- * @return the OptionBuilder instance.
+ * @return The OptionBuilder instance.
* @since 1.3
*/
public static OptionBuilder withType(final Class<?> newType) {
@@ -280,7 +280,7 @@ public final class OptionBuilder {
* object.
*
* @param newType the type of the Options argument value.
- * @return the OptionBuilder instance.
+ * @return The OptionBuilder instance.
* @deprecated Since 1.3, use {@link #withType(Class)} instead.
*/
@Deprecated
@@ -301,7 +301,7 @@ public final class OptionBuilder {
* String propertyValue = opt.getValue(1);
* </pre>
*
- * @return the OptionBuilder instance.
+ * @return The OptionBuilder instance.
*/
public static OptionBuilder withValueSeparator() {
valueSeparator = Char.EQUAL;
@@ -323,7 +323,7 @@ public final class OptionBuilder {
* </pre>
*
* @param sep The value separator to be used for the argument values.
- * @return the OptionBuilder instance.
+ * @return The OptionBuilder instance.
*/
public static OptionBuilder withValueSeparator(final char sep) {
valueSeparator = sep;
diff --git a/src/main/java/org/apache/commons/cli/OptionGroup.java
b/src/main/java/org/apache/commons/cli/OptionGroup.java
index e6403c52..cf092c36 100644
--- a/src/main/java/org/apache/commons/cli/OptionGroup.java
+++ b/src/main/java/org/apache/commons/cli/OptionGroup.java
@@ -65,7 +65,7 @@ public class OptionGroup implements Serializable {
/**
* Gets the names of the options in this group as a {@code Collection}.
*
- * @return the names of the options in this group as a {@code Collection}.
+ * @return The names of the options in this group as a {@code Collection}.
*/
public Collection<String> getNames() {
// the key set is the collection of names
@@ -75,7 +75,7 @@ public class OptionGroup implements Serializable {
/**
* Gets the options in this group as a {@code Collection}.
*
- * @return the options in this group as a {@code Collection}.
+ * @return The options in this group as a {@code Collection}.
*/
public Collection<Option> getOptions() {
// the values are the collection of options
@@ -87,7 +87,7 @@ public class OptionGroup implements Serializable {
*
* If the selected option is deprecated <em>no warning is logged</em>.
*
- * @return the selected option name.
+ * @return The selected option name.
*/
public String getSelected() {
return selected;
@@ -149,7 +149,7 @@ public class OptionGroup implements Serializable {
/**
* Returns the stringified version of this OptionGroup.
*
- * @return the stringified representation of this group.
+ * @return The stringified representation of this group.
*/
@Override
public String toString() {
diff --git a/src/main/java/org/apache/commons/cli/Options.java
b/src/main/java/org/apache/commons/cli/Options.java
index 7f0cda15..ffcbaf07 100644
--- a/src/main/java/org/apache/commons/cli/Options.java
+++ b/src/main/java/org/apache/commons/cli/Options.java
@@ -68,7 +68,7 @@ public class Options implements Serializable {
* Adds an option instance.
*
* @param opt the option that is to be added.
- * @return the resulting Options instance.
+ * @return The resulting Options instance.
*/
public Options addOption(final Option opt) {
final String key = opt.getKey();
@@ -96,7 +96,7 @@ public class Options implements Serializable {
* @param opt Short single-character name of the option.
* @param hasArg flag signaling if an argument is required after this
option.
* @param description Self-documenting description.
- * @return the resulting Options instance.
+ * @return The resulting Options instance.
*/
public Options addOption(final String opt, final boolean hasArg, final
String description) {
addOption(opt, null, hasArg, description);
@@ -111,7 +111,7 @@ public class Options implements Serializable {
*
* @param opt Short single-character name of the option.
* @param description Self-documenting description.
- * @return the resulting Options instance.
+ * @return The resulting Options instance.
* @since 1.3
*/
public Options addOption(final String opt, final String description) {
@@ -129,7 +129,7 @@ public class Options implements Serializable {
* @param longOpt Long multi-character name of the option.
* @param hasArg flag signaling if an argument is required after this
option.
* @param description Self-documenting description.
- * @return the resulting Options instance.
+ * @return The resulting Options instance.
*/
public Options addOption(final String opt, final String longOpt, final
boolean hasArg, final String description) {
addOption(new Option(opt, longOpt, hasArg, description));
@@ -144,7 +144,7 @@ public class Options implements Serializable {
* </p>
*
* @param optionGroup the OptionGroup that is to be added.
- * @return the resulting Options instance.
+ * @return The resulting Options instance.
*/
public Options addOptionGroup(final OptionGroup optionGroup) {
if (optionGroup.isRequired()) {
@@ -199,7 +199,7 @@ public class Options implements Serializable {
* @param longOpt Long multi-character name of the option.
* @param hasArg flag signaling if an argument is required after this
option.
* @param description Self-documenting description.
- * @return the resulting Options instance.
+ * @return The resulting Options instance.
* @since 1.4
*/
public Options addRequiredOption(final String opt, final String longOpt,
final boolean hasArg, final String description) {
@@ -213,7 +213,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.
- * @return the options matching the partial name specified, or an empty
list if none matches.
+ * @return The options matching the partial name specified, or an empty
list if none matches.
* @since 1.3
*/
public List<String> getMatchingOptions(final String opt) {
@@ -238,7 +238,7 @@ public class Options implements Serializable {
* </p>
*
* @param opt short or long name of the {@link Option}.
- * @return the option represented by opt.
+ * @return The option represented by opt.
*/
public Option getOption(final String opt) {
final String clean = Util.stripLeadingHyphens(opt);
@@ -250,7 +250,7 @@ public class Options implements Serializable {
* Gets the OptionGroup the {@code opt} belongs to.
*
* @param option the option whose OptionGroup is being queried.
- * @return the OptionGroup if {@code opt} is part of an OptionGroup,
otherwise return null.
+ * @return The OptionGroup if {@code opt} is part of an OptionGroup,
otherwise return null.
*/
public OptionGroup getOptionGroup(final Option option) {
return optionGroups.get(option.getKey());
@@ -325,7 +325,7 @@ public class Options implements Serializable {
/**
* Returns the Options for use by the HelpFormatter.
*
- * @return the List of Options.
+ * @return The List of Options.
*/
List<Option> helpOptions() {
return new ArrayList<>(shortOpts.values());
diff --git a/src/main/java/org/apache/commons/cli/ParseException.java
b/src/main/java/org/apache/commons/cli/ParseException.java
index a8a67f22..da501fd1 100644
--- a/src/main/java/org/apache/commons/cli/ParseException.java
+++ b/src/main/java/org/apache/commons/cli/ParseException.java
@@ -35,7 +35,7 @@ public class ParseException extends Exception {
* </p>
*
* @param e the exception to convert.
- * @return the ParseException.
+ * @return The ParseException.
* @throws UnsupportedOperationException due to legacy expectations. Will
be removed in the future.
* @since 1.7.0
*/
diff --git a/src/main/java/org/apache/commons/cli/Parser.java
b/src/main/java/org/apache/commons/cli/Parser.java
index 2ef6e9c9..259b4ab1 100644
--- a/src/main/java/org/apache/commons/cli/Parser.java
+++ b/src/main/java/org/apache/commons/cli/Parser.java
@@ -76,7 +76,7 @@ public abstract class Parser implements CommandLineParser {
/**
* Gets the options.
*
- * @return the options.
+ * @return The options.
*/
protected Options getOptions() {
return options;
@@ -85,7 +85,7 @@ public abstract class Parser implements CommandLineParser {
/**
* Gets the required options.
*
- * @return the required options.
+ * @return The required options.
*/
protected List getRequiredOptions() {
return requiredOptions;
@@ -96,7 +96,7 @@ public abstract class Parser implements CommandLineParser {
*
* @param options the {@code Options}.
* @param arguments the {@code arguments}.
- * @return the {@code CommandLine}.
+ * @return The {@code CommandLine}.
* @throws ParseException if there are any problems encountered while
parsing the command line tokens.
*/
@Override
@@ -112,7 +112,7 @@ public abstract class Parser implements CommandLineParser {
* @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.
- * @return the {@code CommandLine}.
+ * @return The {@code CommandLine}.
* @throws ParseException if an error occurs when parsing the arguments.
*/
@Override
@@ -126,7 +126,7 @@ public abstract class Parser implements CommandLineParser {
* @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.
+ * @return The list of atomic option and value tokens.
* @throws ParseException if there are any problems encountered while
parsing the command line tokens.
* @since 1.1
*/
@@ -143,7 +143,7 @@ public abstract class Parser implements CommandLineParser {
* @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.
- * @return the list of atomic option and value tokens.
+ * @return The list of atomic option and value tokens.
* @throws ParseException if there are any problems encountered while
parsing the command line tokens.
* @since 1.1
*/
diff --git a/src/main/java/org/apache/commons/cli/TypeHandler.java
b/src/main/java/org/apache/commons/cli/TypeHandler.java
index a9136759..e3cc0246 100644
--- a/src/main/java/org/apache/commons/cli/TypeHandler.java
+++ b/src/main/java/org/apache/commons/cli/TypeHandler.java
@@ -114,7 +114,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.
- * @return the number represented by {@code string}.
+ * @return The number represented by {@code string}.
* @throws ParseException if {@code string} is not a number.
*/
@Deprecated // since 1.7.0
@@ -126,7 +126,7 @@ public class TypeHandler {
* Creates an Object from the class name and empty constructor.
*
* @param className the argument value.
- * @return the initialized object.
+ * @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)}.
*/
@@ -197,7 +197,7 @@ public class TypeHandler {
/**
* Gets the default TypeHandler.
*
- * @return the default TypeHandler.
+ * @return The default TypeHandler.
* @since 1.7.0
*/
public static TypeHandler getDefault() {
@@ -280,7 +280,7 @@ public class TypeHandler {
*
* @param <T> The Class parameter type.
* @param clazz The Class to get the Converter for.
- * @return the registered converter if any, {@link Converter#DEFAULT}
otherwise.
+ * @return The registered converter if any, {@link Converter#DEFAULT}
otherwise.
* @since 1.7.0
*/
@SuppressWarnings("unchecked") // returned value will have type T because
it is fixed by clazz
diff --git
a/src/main/java/org/apache/commons/cli/UnrecognizedOptionException.java
b/src/main/java/org/apache/commons/cli/UnrecognizedOptionException.java
index 49f0ed29..6428d223 100644
--- a/src/main/java/org/apache/commons/cli/UnrecognizedOptionException.java
+++ b/src/main/java/org/apache/commons/cli/UnrecognizedOptionException.java
@@ -54,7 +54,7 @@ public class UnrecognizedOptionException extends
ParseException {
/**
* Gets the unrecognized option.
*
- * @return the related option.
+ * @return The related option.
* @since 1.2
*/
public String getOption() {
diff --git a/src/main/java/org/apache/commons/cli/Util.java
b/src/main/java/org/apache/commons/cli/Util.java
index cca7369f..fa18bb1c 100644
--- a/src/main/java/org/apache/commons/cli/Util.java
+++ b/src/main/java/org/apache/commons/cli/Util.java
@@ -33,7 +33,7 @@ final class Util {
* Tests whether the given array is null or empty.
*
* @param array the array to test.
- * @return the given array is null or empty.
+ * @return The given array is null or empty.
*/
static boolean isEmpty(final Object[] array) {
return array == null || array.length == 0;
@@ -70,7 +70,7 @@ final class Util {
* Removes the hyphens from the beginning of {@code str} and return the
new String.
*
* @param str The string from which the hyphens should be removed.
- * @return the new String.
+ * @return The new String.
*/
static String stripLeadingHyphens(final String str) {
if (isEmpty(str)) {
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 cf0c6ee0..478454aa 100644
--- a/src/main/java/org/apache/commons/cli/help/AbstractHelpFormatter.java
+++ b/src/main/java/org/apache/commons/cli/help/AbstractHelpFormatter.java
@@ -85,7 +85,7 @@ public abstract class AbstractHelpFormatter {
/**
* Gets the comparator to sort lists of options.
*
- * @return the comparator to sort lists of options.
+ * @return The comparator to sort lists of options.
*/
protected Comparator<Option> getComparator() {
return comparator;
@@ -94,7 +94,7 @@ public abstract class AbstractHelpFormatter {
/**
* Gets {@link HelpAppendable}.
*
- * @return the {@link HelpAppendable}.
+ * @return The {@link HelpAppendable}.
*/
protected HelpAppendable getHelpAppendable() {
return helpAppendable;
@@ -103,7 +103,7 @@ public abstract class AbstractHelpFormatter {
/**
* Gets {@link OptionFormatter.Builder} to use to format options in
the table.
*
- * @return the {@link OptionFormatter.Builder} to use to format
options in the table.
+ * @return The {@link OptionFormatter.Builder} to use to format
options in the table.
*/
protected OptionFormatter.Builder getOptionFormatBuilder() {
return optionFormatBuilder;
@@ -112,7 +112,7 @@ public abstract class AbstractHelpFormatter {
/**
* Gets string to separate option groups.
*
- * @return the string to separate option groups.
+ * @return The string to separate option groups.
*/
protected String getOptionGroupSeparator() {
return optionGroupSeparator;
@@ -280,7 +280,7 @@ public abstract class AbstractHelpFormatter {
* Converts a collection of {@link Option}s into a {@link TableDefinition}.
*
* @param options The options to create a table for.
- * @return the TableDefinition.
+ * @return The TableDefinition.
*/
protected abstract TableDefinition getTableDefinition(Iterable<Option>
options);
@@ -411,7 +411,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.
- * @return the {@code argName} formatted as an argument.
+ * @return The {@code argName} formatted as an argument.
*/
public final String toArgName(final String argName) {
return optionFormatBuilder.toArgName(argName);
@@ -426,7 +426,7 @@ public abstract class AbstractHelpFormatter {
* </p>
*
* @param options The collection of {@link Option} instances to create the
string representation for.
- * @return the string representation of the options as used in the syntax
display.
+ * @return The string representation of the options as used in the syntax
display.
*/
public String toSyntaxOptions(final Iterable<Option> options) {
return toSyntaxOptions(options, o -> null);
@@ -437,7 +437,7 @@ public abstract class AbstractHelpFormatter {
*
* @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.
- * @return the string representation of the options as used in the syntax
display.
+ * @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) {
// list of groups that have been processed.
@@ -475,7 +475,7 @@ public abstract class AbstractHelpFormatter {
* Return the string representation of the options as used in the syntax
display.
*
* @param group The OptionGroup to create the string representation for.
- * @return the string representation of the options as used in the syntax
display.
+ * @return The string representation of the options as used in the syntax
display.
*/
public String toSyntaxOptions(final OptionGroup group) {
final StringBuilder buff = new StringBuilder();
@@ -501,7 +501,7 @@ public abstract class AbstractHelpFormatter {
* Return the string representation of the options as used in the syntax
display.
*
* @param options The {@link Options} to create the string representation
for.
- * @return the string representation of the options as used in the syntax
display.
+ * @return The string representation of the options as used in the syntax
display.
*/
public String toSyntaxOptions(final Options options) {
return toSyntaxOptions(options.getOptions(), options::getOptionGroup);
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 9e9089c2..8008fd33 100644
--- a/src/main/java/org/apache/commons/cli/help/OptionFormatter.java
+++ b/src/main/java/org/apache/commons/cli/help/OptionFormatter.java
@@ -218,7 +218,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.
- * @return the formatted argument.
+ * @return The formatted argument.
*/
public String toArgName(final String argName) {
return argNameDelimiters[0] + Util.defaultValue(argName, "") +
argNameDelimiters[1];
@@ -462,7 +462,7 @@ public final class OptionFormatter {
/**
* Gets the syntax format for this option.
*
- * @return the syntax format for this option as specified by the
syntaxFormatFunction.
+ * @return The syntax format for this option as specified by the
syntaxFormatFunction.
*/
public String toSyntaxOption() {
return toSyntaxOption(isRequired());
@@ -472,7 +472,7 @@ public final class OptionFormatter {
* Gets the syntax format for this option.
*
* @param isRequired if {@code true} the options is printed as a required
option, otherwise it is optional.
- * @return the syntax format for this option as specified by the
syntaxFormatFunction.
+ * @return The syntax format for this option as specified by the
syntaxFormatFunction.
*/
public String toSyntaxOption(final boolean isRequired) {
return syntaxFormatFunction.apply(this, isRequired);
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 73d60e5b..52b08add 100644
--- a/src/main/java/org/apache/commons/cli/help/TableDefinition.java
+++ b/src/main/java/org/apache/commons/cli/help/TableDefinition.java
@@ -79,7 +79,7 @@ public interface TableDefinition {
/**
* Gets the list TextStyles. One for each column in order.
*
- * @return the list of TextStyles.
+ * @return The list of TextStyles.
*/
List<TextStyle> columnTextStyles();
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 0ca02fe9..51aa5b7b 100644
--- a/src/main/java/org/apache/commons/cli/help/TextHelpAppendable.java
+++ b/src/main/java/org/apache/commons/cli/help/TextHelpAppendable.java
@@ -264,7 +264,7 @@ public class TextHelpAppendable extends
FilterHelpAppendable {
/**
* Gets the indent for the output.
*
- * @return the indent of the page.
+ * @return The indent of the page.
*/
public int getIndent() {
return textStyleBuilder.getIndent();
@@ -282,7 +282,7 @@ public class TextHelpAppendable extends
FilterHelpAppendable {
/**
* Gets the maximum width for the output
*
- * @return the maximum width for the output.
+ * @return The maximum width for the output.
*/
public int getMaxWidth() {
return textStyleBuilder.getMaxWidth();
@@ -376,7 +376,7 @@ public class TextHelpAppendable extends
FilterHelpAppendable {
*
* @param orig the original size.
* @param fraction the fractional adjustment.
- * @return the resized value.
+ * @return The resized value.
*/
private int resize(final int orig, final double fraction) {
return (int) (orig * fraction);
@@ -387,7 +387,7 @@ public class TextHelpAppendable extends
FilterHelpAppendable {
*
* @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.
+ * @return The builder with the maximum width and indent values resized.
*/
protected TextStyle.Builder resize(final TextStyle.Builder builder, final
double fraction) {
final double indentFrac = builder.getIndent() * 1.0 /
builder.getMaxWidth();
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 f7851e4b..15cc541e 100644
--- a/src/main/java/org/apache/commons/cli/help/TextStyle.java
+++ b/src/main/java/org/apache/commons/cli/help/TextStyle.java
@@ -279,7 +279,7 @@ public final class TextStyle {
/**
* Gets the alignment.
*
- * @return the alignment.
+ * @return The alignment.
*/
public Alignment getAlignment() {
return alignment;
@@ -288,7 +288,7 @@ public final class TextStyle {
/**
* Gets the indent value.
*
- * @return the indent value.
+ * @return The indent value.
*/
public int getIndent() {
return indent;
@@ -297,7 +297,7 @@ public final class TextStyle {
/**
* Gets the left padding.
*
- * @return the left padding.
+ * @return The left padding.
*/
public int getLeftPad() {
return leftPad;
@@ -324,7 +324,7 @@ public final class TextStyle {
/**
* Specifies if the column can be made wider or to narrower width to fit
constraints of the HelpAppendable and formatting.
*
- * @return the scaling value.
+ * @return The scaling value.
*/
public boolean isScalable() {
return scalable;
@@ -339,7 +339,7 @@ public final class TextStyle {
*
* @param addIndent if {@code true} account for the indent when padding
the string.
* @param text the text to pad.
- * @return the padded string.
+ * @return The padded string.
*/
public CharSequence pad(final boolean addIndent, final CharSequence text) {
if (text.length() >= maxWidth) {
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 2d8eb3b9..e51e286b 100644
--- a/src/main/java/org/apache/commons/cli/help/Util.java
+++ b/src/main/java/org/apache/commons/cli/help/Util.java
@@ -35,7 +35,7 @@ final class Util {
* @param str The string to check.
* @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,
+ * @return The {@code defaultValue} if {@code str} is empty,
*/
static <T extends CharSequence> T defaultValue(final T str, final T
defaultValue) {
return isEmpty(str) ? defaultValue : str;
@@ -46,7 +46,7 @@ final class Util {
*
* @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.
+ * @return The index of the first non whitespace character or -1 if non
found.
*/
static int indexOfNonWhitespace(final CharSequence text, final int
startPos) {
if (isEmpty(text)) {
