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 70c7039a Javadoc
70c7039a is described below
commit 70c7039a18a5bfb59ef266e202b4125f7950b497
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 09:08:15 2026 -0400
Javadoc
---
.../java/org/apache/commons/cli/AmbiguousOptionException.java | 2 +-
src/main/java/org/apache/commons/cli/CommandLine.java | 10 +++++-----
src/main/java/org/apache/commons/cli/DefaultParser.java | 2 +-
src/main/java/org/apache/commons/cli/DeprecatedAttributes.java | 2 +-
src/main/java/org/apache/commons/cli/GnuParser.java | 2 +-
src/main/java/org/apache/commons/cli/HelpFormatter.java | 4 ++--
src/main/java/org/apache/commons/cli/Option.java | 8 ++++----
src/main/java/org/apache/commons/cli/Options.java | 2 +-
src/main/java/org/apache/commons/cli/Parser.java | 2 +-
src/main/java/org/apache/commons/cli/TypeHandler.java | 2 +-
.../org/apache/commons/cli/help/AbstractHelpFormatter.java | 6 +++---
src/main/java/org/apache/commons/cli/help/HelpFormatter.java | 2 +-
src/main/java/org/apache/commons/cli/help/OptionFormatter.java | 4 ++--
.../java/org/apache/commons/cli/help/TextHelpAppendable.java | 4 ++--
src/main/java/org/apache/commons/cli/help/TextStyle.java | 2 +-
15 files changed, 27 insertions(+), 27 deletions(-)
diff --git a/src/main/java/org/apache/commons/cli/AmbiguousOptionException.java
b/src/main/java/org/apache/commons/cli/AmbiguousOptionException.java
index 86cefd19..08ed4e5c 100644
--- a/src/main/java/org/apache/commons/cli/AmbiguousOptionException.java
+++ b/src/main/java/org/apache/commons/cli/AmbiguousOptionException.java
@@ -73,7 +73,7 @@ public class AmbiguousOptionException extends
UnrecognizedOptionException {
/**
* Gets the options matching the partial name.
*
- * @return a collection of options matching the name.
+ * @return A collection of options matching the name.
*/
public Collection<String> getMatchingOptions() {
return matchingOptions;
diff --git a/src/main/java/org/apache/commons/cli/CommandLine.java
b/src/main/java/org/apache/commons/cli/CommandLine.java
index 2d3c7ac3..f62ab89b 100644
--- a/src/main/java/org/apache/commons/cli/CommandLine.java
+++ b/src/main/java/org/apache/commons/cli/CommandLine.java
@@ -102,7 +102,7 @@ public class CommandLine implements Serializable {
/**
* Creates a new instance.
*
- * @return a new instance.
+ * @return A new instance.
* @deprecated Use {@link #get()}.
*/
@Deprecated
@@ -113,7 +113,7 @@ public class CommandLine implements Serializable {
/**
* Creates a new instance.
*
- * @return a new instance.
+ * @return A new instance.
* @since 1.10.0
*/
@Override
@@ -140,7 +140,7 @@ public class CommandLine implements Serializable {
/**
* Creates a new builder.
*
- * @return a new builder.
+ * @return A new builder.
* @since 1.7.0
*/
public static Builder builder() {
@@ -337,7 +337,7 @@ public class CommandLine implements Serializable {
/**
* Gets an array of the processed {@link Option}s.
*
- * @return an array of the processed {@link Option}s.
+ * @return An array of the processed {@link Option}s.
*/
public Option[] getOptions() {
return options.toArray(Option.EMPTY_ARRAY);
@@ -1006,7 +1006,7 @@ public class CommandLine implements Serializable {
/**
* Returns an iterator over the Option members of CommandLine.
*
- * @return an {@code Iterator} over the processed {@link Option} members
of this {@link CommandLine}.
+ * @return An {@code Iterator} over the processed {@link Option} members
of this {@link CommandLine}.
*/
public Iterator<Option> iterator() {
return options.iterator();
diff --git a/src/main/java/org/apache/commons/cli/DefaultParser.java
b/src/main/java/org/apache/commons/cli/DefaultParser.java
index 801a989e..e1910ccf 100644
--- a/src/main/java/org/apache/commons/cli/DefaultParser.java
+++ b/src/main/java/org/apache/commons/cli/DefaultParser.java
@@ -190,7 +190,7 @@ public class DefaultParser implements CommandLineParser {
* Creates a new {@link Builder} to create an {@link DefaultParser} using
descriptive
* methods.
*
- * @return a new {@link Builder} instance
+ * @return A new {@link Builder} instance
* @since 1.5.0
*/
public static Builder builder() {
diff --git a/src/main/java/org/apache/commons/cli/DeprecatedAttributes.java
b/src/main/java/org/apache/commons/cli/DeprecatedAttributes.java
index 50dc344a..78830c00 100644
--- a/src/main/java/org/apache/commons/cli/DeprecatedAttributes.java
+++ b/src/main/java/org/apache/commons/cli/DeprecatedAttributes.java
@@ -118,7 +118,7 @@ public final class DeprecatedAttributes {
/**
* Creates a new builder.
*
- * @return a new builder.
+ * @return A new builder.
*/
public static Builder builder() {
return new Builder();
diff --git a/src/main/java/org/apache/commons/cli/GnuParser.java
b/src/main/java/org/apache/commons/cli/GnuParser.java
index 6d2b8715..7c575092 100644
--- a/src/main/java/org/apache/commons/cli/GnuParser.java
+++ b/src/main/java/org/apache/commons/cli/GnuParser.java
@@ -50,7 +50,7 @@ public class GnuParser extends Parser {
* @param options The Options to parse the arguments by.
* @param arguments The arguments that have to be flattened.
* @param stopAtNonOption specifies whether to stop flattening when a non
option has been encountered.
- * @return a String array of the flattened arguments.
+ * @return A String array of the flattened arguments.
*/
@Override
protected String[] flatten(final Options options, final String[]
arguments, final boolean stopAtNonOption) {
diff --git a/src/main/java/org/apache/commons/cli/HelpFormatter.java
b/src/main/java/org/apache/commons/cli/HelpFormatter.java
index 48991609..2b0d99a8 100644
--- a/src/main/java/org/apache/commons/cli/HelpFormatter.java
+++ b/src/main/java/org/apache/commons/cli/HelpFormatter.java
@@ -172,7 +172,7 @@ public class HelpFormatter {
*
* @param opt1 The first Option to be compared.
* @param opt2 The second Option to be compared.
- * @return a negative integer, zero, or a positive integer as the
first argument is less than, equal to, or greater than
+ * @return A negative integer, zero, or a positive integer as the
first argument is less than, equal to, or greater than
* the second.
*/
@Override
@@ -221,7 +221,7 @@ public class HelpFormatter {
/**
* Creates a new builder.
*
- * @return a new builder.
+ * @return A new builder.
* @since 1.7.0
*/
public static Builder builder() {
diff --git a/src/main/java/org/apache/commons/cli/Option.java
b/src/main/java/org/apache/commons/cli/Option.java
index 5cb44213..ce32f0bf 100644
--- a/src/main/java/org/apache/commons/cli/Option.java
+++ b/src/main/java/org/apache/commons/cli/Option.java
@@ -367,7 +367,7 @@ public class Option implements Cloneable, Serializable {
/**
* Returns a {@link Builder} to create an {@link Option} using descriptive
methods.
*
- * @return a new {@link Builder} instance.
+ * @return A new {@link Builder} instance.
* @since 1.3
*/
public static Builder builder() {
@@ -378,7 +378,7 @@ public class Option implements Cloneable, Serializable {
* Returns a {@link Builder} to create an {@link Option} using descriptive
methods.
*
* @param option short representation of the option.
- * @return a new {@link Builder} instance.
+ * @return A new {@link Builder} instance.
* @throws IllegalArgumentException if there are any non valid Option
characters in {@code opt}.
* @since 1.3
*/
@@ -550,7 +550,7 @@ public class Option implements Cloneable, Serializable {
*
* After calling this method, it is very likely you will want to call
clearValues().
*
- * @return a clone of this Option instance.
+ * @return A clone of this Option instance.
* @throws RuntimeException if a {@link CloneNotSupportedException} has
been thrown by {@code super.clone()}.
*/
@Override
@@ -1000,7 +1000,7 @@ public class Option implements Cloneable, Serializable {
/**
* Creates a String suitable for debugging.
*
- * @return a String suitable for debugging.
+ * @return A String suitable for debugging.
*/
@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 ffcbaf07..4c8ef9e9 100644
--- a/src/main/java/org/apache/commons/cli/Options.java
+++ b/src/main/java/org/apache/commons/cli/Options.java
@@ -259,7 +259,7 @@ public class Options implements Serializable {
/**
* Gets the OptionGroups that are members of this Options instance.
*
- * @return a Collection of OptionGroup instances.
+ * @return A Collection of OptionGroup instances.
*/
Collection<OptionGroup> getOptionGroups() {
diff --git a/src/main/java/org/apache/commons/cli/Parser.java
b/src/main/java/org/apache/commons/cli/Parser.java
index 259b4ab1..19f01cc7 100644
--- a/src/main/java/org/apache/commons/cli/Parser.java
+++ b/src/main/java/org/apache/commons/cli/Parser.java
@@ -68,7 +68,7 @@ public abstract class Parser implements CommandLineParser {
* @param opts The Options to parse the arguments by.
* @param arguments The arguments that have to be flattened.
* @param stopAtNonOption specifies whether to stop flattening when a non
option has been encountered.
- * @return a String array of the flattened arguments.
+ * @return A String array of the flattened arguments.
* @throws ParseException if there are any problems encountered while
parsing the command line tokens.
*/
protected abstract String[] flatten(Options opts, String[] arguments,
boolean stopAtNonOption) throws ParseException;
diff --git a/src/main/java/org/apache/commons/cli/TypeHandler.java
b/src/main/java/org/apache/commons/cli/TypeHandler.java
index e3cc0246..5cc0bef9 100644
--- a/src/main/java/org/apache/commons/cli/TypeHandler.java
+++ b/src/main/java/org/apache/commons/cli/TypeHandler.java
@@ -74,7 +74,7 @@ public class TypeHandler {
/**
* Creates a default converter map.
*
- * @return a default converter map.
+ * @return A default converter map.
* @since 1.7.0
*/
public static Map<Class<?>, Converter<?, ? extends Throwable>>
createDefaultMap() {
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 478454aa..ef53ad28 100644
--- a/src/main/java/org/apache/commons/cli/help/AbstractHelpFormatter.java
+++ b/src/main/java/org/apache/commons/cli/help/AbstractHelpFormatter.java
@@ -243,7 +243,7 @@ public abstract class AbstractHelpFormatter {
* Constructs an {@link OptionFormatter} for the specified {@link Option}.
*
* @param option The Option to format.
- * @return an {@link OptionFormatter} for the specified {@link Option}.
+ * @return An {@link OptionFormatter} for the specified {@link Option}.
*/
public final OptionFormatter getOptionFormatter(final Option option) {
return optionFormatBuilder.build(option);
@@ -386,7 +386,7 @@ public abstract class AbstractHelpFormatter {
* Creates a new list of options ordered by the comparator.
*
* @param options the Options to sort.
- * @return a new list of options ordered by the comparator.
+ * @return A new list of options ordered by the comparator.
*/
public List<Option> sort(final Iterable<Option> options) {
final List<Option> result = new ArrayList<>();
@@ -401,7 +401,7 @@ public abstract class AbstractHelpFormatter {
* Creates a new list of options ordered by the comparator.
*
* @param options the Options to sort.
- * @return a new list of options ordered by the comparator.
+ * @return A new list of options ordered by the comparator.
*/
public List<Option> sort(final Options options) {
return sort(options == null ? null : options.getOptions());
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 781c695f..43c57393 100644
--- a/src/main/java/org/apache/commons/cli/help/HelpFormatter.java
+++ b/src/main/java/org/apache/commons/cli/help/HelpFormatter.java
@@ -134,7 +134,7 @@ public class HelpFormatter extends AbstractHelpFormatter {
/**
* Constructs a new builder.
*
- * @return a new builder.
+ * @return A new builder.
*/
public static Builder builder() {
return new Builder();
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 8008fd33..4f999c88 100644
--- a/src/main/java/org/apache/commons/cli/help/OptionFormatter.java
+++ b/src/main/java/org/apache/commons/cli/help/OptionFormatter.java
@@ -296,7 +296,7 @@ public final class OptionFormatter {
/**
* Creates a new builder.
*
- * @return a new builder.
+ * @return A new builder.
*/
public static Builder builder() {
return new Builder();
@@ -306,7 +306,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.
- * @return an OptionFormatter for the specified @{code option}.
+ * @return An OptionFormatter for the specified @{code option}.
*/
public static OptionFormatter from(final Option option) {
return new Builder().build(option);
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 51aa5b7b..74d07ce3 100644
--- a/src/main/java/org/apache/commons/cli/help/TextHelpAppendable.java
+++ b/src/main/java/org/apache/commons/cli/help/TextHelpAppendable.java
@@ -103,7 +103,7 @@ public class TextHelpAppendable extends
FilterHelpAppendable {
/**
* Creates a new TextHelpAppendable on {@link System#out}.
*
- * @return a new TextHelpAppendable on {@link System#out}.
+ * @return A new TextHelpAppendable on {@link System#out}.
*/
protected static TextHelpAppendable systemOut() {
return new TextHelpAppendable(System.out);
@@ -144,7 +144,7 @@ public class TextHelpAppendable extends
FilterHelpAppendable {
* </p>
*
* @param table the table to adjust.
- * @return a new TableDefinition with adjusted values.
+ * @return A new TableDefinition with adjusted values.
*/
protected TableDefinition adjustTableFormat(final TableDefinition table) {
final List<TextStyle.Builder> styleBuilders = new ArrayList<>();
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 15cc541e..e76b600a 100644
--- a/src/main/java/org/apache/commons/cli/help/TextStyle.java
+++ b/src/main/java/org/apache/commons/cli/help/TextStyle.java
@@ -238,7 +238,7 @@ public final class TextStyle {
/**
* Creates a new builder.
*
- * @return a new builder.
+ * @return A new builder.
*/
public static Builder builder() {
return new Builder();
