This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-cli.git
The following commit(s) were added to refs/heads/master by this push:
new fd459881 Javadoc: Empty Javadoc line before the 1st tag.
fd459881 is described below
commit fd459881e010fadcd3b26e36bafbc90163643ac6
Author: Gary Gregory <[email protected]>
AuthorDate: Wed Dec 31 17:39:49 2025 -0500
Javadoc: Empty Javadoc line before the 1st tag.
---
src/main/java/org/apache/commons/cli/HelpFormatter.java | 4 ++++
src/main/java/org/apache/commons/cli/Option.java | 1 +
src/main/java/org/apache/commons/cli/OptionGroup.java | 3 +++
src/main/java/org/apache/commons/cli/OptionValidator.java | 3 +++
src/main/java/org/apache/commons/cli/help/AbstractHelpFormatter.java | 1 +
5 files changed, 12 insertions(+)
diff --git a/src/main/java/org/apache/commons/cli/HelpFormatter.java
b/src/main/java/org/apache/commons/cli/HelpFormatter.java
index febdf4c8..8873adda 100644
--- a/src/main/java/org/apache/commons/cli/HelpFormatter.java
+++ b/src/main/java/org/apache/commons/cli/HelpFormatter.java
@@ -67,6 +67,7 @@ import org.apache.commons.cli.help.OptionFormatter;
*
* Please report issues at https://example.com/issues
* }</pre>
+ *
* @deprecated Use {@link org.apache.commons.cli.help.HelpFormatter}.
*/
@Deprecated
@@ -146,6 +147,7 @@ public class HelpFormatter {
/**
* Sets whether to show the date the option was first added.
+ *
* @param showSince if @{code true} the date the options was first
added will be shown.
* @return this builder.
* @since 1.9.0
@@ -232,6 +234,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}.
* @since 1.8.0
@@ -339,6 +342,7 @@ public class HelpFormatter {
/**
* Constructs a new instance.
+ *
* @param printWriter TODO
*/
private HelpFormatter(final Function<Option, String>
deprecatedFormatFunction, final PrintWriter printWriter, final boolean
showSince) {
diff --git a/src/main/java/org/apache/commons/cli/Option.java
b/src/main/java/org/apache/commons/cli/Option.java
index 3f16186a..61436992 100644
--- a/src/main/java/org/apache/commons/cli/Option.java
+++ b/src/main/java/org/apache/commons/cli/Option.java
@@ -673,6 +673,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.
*/
public String getSince() {
diff --git a/src/main/java/org/apache/commons/cli/OptionGroup.java
b/src/main/java/org/apache/commons/cli/OptionGroup.java
index ed574dc1..e6403c52 100644
--- a/src/main/java/org/apache/commons/cli/OptionGroup.java
+++ b/src/main/java/org/apache/commons/cli/OptionGroup.java
@@ -86,6 +86,7 @@ public class OptionGroup implements Serializable {
* Gets the selected option name.
*
* If the selected option is deprecated <em>no warning is logged</em>.
+ *
* @return the selected option name.
*/
public String getSelected() {
@@ -105,6 +106,7 @@ public class OptionGroup implements Serializable {
* Tests whether an option is selected.
*
* If an option is selected and is deprecated <em>no warning is
logged</em>.
+ *
* @return whether whether an option is selected.
* @since 1.9.0
*/
@@ -125,6 +127,7 @@ public class OptionGroup implements Serializable {
* Sets the selected option of this group to {@code name}.
*
* If the selected option is deprecated <em>no warning is logged</em>.
+ *
* @param option the option that is selected.
* @throws AlreadySelectedException if an option from this group has
already been selected.
*/
diff --git a/src/main/java/org/apache/commons/cli/OptionValidator.java
b/src/main/java/org/apache/commons/cli/OptionValidator.java
index 56852f20..df79dc80 100644
--- a/src/main/java/org/apache/commons/cli/OptionValidator.java
+++ b/src/main/java/org/apache/commons/cli/OptionValidator.java
@@ -41,6 +41,7 @@ final class OptionValidator {
* <li>isIdentifierIgnorable returns true for the character</li>
* <li>it is a hyphen/dash ('-')</li>
* </ul>
+ *
* @param c the character to validate
* @return true if {@code c} is a valid character letter.
*/
@@ -62,6 +63,7 @@ final class OptionValidator {
* <li>isIdentifierIgnorable returns true for the character</li>
* <li>it is a question mark or 'at' sign ('?' or '@')</li>
* </ul>
+ *
* @param c the option to validate
* @return true if {@code c} is a letter, '?' or '@', otherwise false.
*/
@@ -71,6 +73,7 @@ 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.
* @return {@code true} if {@code c} was in {@code ary}, {@code false}
otherwise.
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 767abe38..e9182af0 100644
--- a/src/main/java/org/apache/commons/cli/help/AbstractHelpFormatter.java
+++ b/src/main/java/org/apache/commons/cli/help/AbstractHelpFormatter.java
@@ -410,6 +410,7 @@ public abstract class AbstractHelpFormatter {
* of option groups. To display the option grouping use {@link
#toSyntaxOptions(Options)} or
* {@link #toSyntaxOptions(OptionGroup)} for individual groups.
* </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.
*/
