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 3da83eeb No need for blank Javadoc lines between Javadoc @ tags
3da83eeb is described below
commit 3da83eebe3cccfae8505913ef9126f706654245d
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Thu Nov 28 12:00:34 2024 -0500
No need for blank Javadoc lines between Javadoc @ tags
---
src/main/java/org/apache/commons/cli/CommandLine.java | 2 --
src/main/java/org/apache/commons/cli/CommandLineParser.java | 2 --
src/main/java/org/apache/commons/cli/DefaultParser.java | 1 -
src/main/java/org/apache/commons/cli/HelpFormatter.java | 4 ----
src/main/java/org/apache/commons/cli/Option.java | 6 ------
src/main/java/org/apache/commons/cli/OptionBuilder.java | 1 -
src/main/java/org/apache/commons/cli/help/Util.java | 1 -
7 files changed, 17 deletions(-)
diff --git a/src/main/java/org/apache/commons/cli/CommandLine.java
b/src/main/java/org/apache/commons/cli/CommandLine.java
index 00defd1a..3a310b39 100644
--- a/src/main/java/org/apache/commons/cli/CommandLine.java
+++ b/src/main/java/org/apache/commons/cli/CommandLine.java
@@ -76,7 +76,6 @@ public class CommandLine implements Serializable {
* Adds left-over unrecognized option/argument.
*
* @param arg the unrecognized option/argument.
- *
* @return this Builder instance for method chaining.
*/
public Builder addArg(final String arg) {
@@ -90,7 +89,6 @@ public class CommandLine implements Serializable {
* Adds an option to the command line. The values of the option are
stored.
*
* @param opt the processed option.
- *
* @return this Builder instance for method chaining.
*/
public Builder addOption(final Option opt) {
diff --git a/src/main/java/org/apache/commons/cli/CommandLineParser.java
b/src/main/java/org/apache/commons/cli/CommandLineParser.java
index bc6b17e8..23a35c63 100644
--- a/src/main/java/org/apache/commons/cli/CommandLineParser.java
+++ b/src/main/java/org/apache/commons/cli/CommandLineParser.java
@@ -29,7 +29,6 @@ public interface CommandLineParser {
* @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.
*/
CommandLine parse(Options options, String[] arguments) throws
ParseException;
@@ -41,7 +40,6 @@ public interface CommandLineParser {
* @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.
*/
/*
diff --git a/src/main/java/org/apache/commons/cli/DefaultParser.java
b/src/main/java/org/apache/commons/cli/DefaultParser.java
index 8e71c31d..a9a807c4 100644
--- a/src/main/java/org/apache/commons/cli/DefaultParser.java
+++ b/src/main/java/org/apache/commons/cli/DefaultParser.java
@@ -693,7 +693,6 @@ public class DefaultParser implements CommandLineParser {
* @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.
*/
public CommandLine parse(final Options options, final String[] arguments,
final Properties properties) throws ParseException {
diff --git a/src/main/java/org/apache/commons/cli/HelpFormatter.java
b/src/main/java/org/apache/commons/cli/HelpFormatter.java
index 4dc01db1..4c8fd668 100644
--- a/src/main/java/org/apache/commons/cli/HelpFormatter.java
+++ b/src/main/java/org/apache/commons/cli/HelpFormatter.java
@@ -523,7 +523,6 @@ public class HelpFormatter {
* Creates a String of padding of length {@code len}.
*
* @param len The length of the String of padding to create.
- *
* @return The String of padding
*/
protected String createPadding(final int len) {
@@ -713,7 +712,6 @@ public class HelpFormatter {
* @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,
@@ -914,7 +912,6 @@ 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.
*/
protected StringBuffer renderOptions(final StringBuffer sb, final int
width, final Options options, final int leftPad, final int descPad) {
@@ -933,7 +930,6 @@ 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.
*/
protected StringBuffer renderWrappedText(final StringBuffer sb, final int
width, final int nextLineTabStop, final String text) {
diff --git a/src/main/java/org/apache/commons/cli/Option.java
b/src/main/java/org/apache/commons/cli/Option.java
index 74a2fccb..b3f7f7f2 100644
--- a/src/main/java/org/apache/commons/cli/Option.java
+++ b/src/main/java/org/apache/commons/cli/Option.java
@@ -445,7 +445,6 @@ public class Option implements Cloneable, Serializable {
* @param option short 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}.
*/
public Option(final String option, final boolean hasArg, final String
description) throws IllegalArgumentException {
@@ -457,7 +456,6 @@ public class Option implements Cloneable, Serializable {
*
* @param option short representation of the option.
* @param description describes the function of the option.
- *
* @throws IllegalArgumentException if there are any non valid Option
characters in {@code opt}.
*/
public Option(final String option, final String description) throws
IllegalArgumentException {
@@ -471,7 +469,6 @@ public class Option implements Cloneable, Serializable {
* @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}.
*/
public Option(final String option, final String longOption, final boolean
hasArg, final String description) throws IllegalArgumentException {
@@ -691,9 +688,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.
- *
* @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 {
@@ -704,7 +699,6 @@ 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.
*/
public String getValue(final String defaultValue) {
diff --git a/src/main/java/org/apache/commons/cli/OptionBuilder.java
b/src/main/java/org/apache/commons/cli/OptionBuilder.java
index 496edf40..78362787 100644
--- a/src/main/java/org/apache/commons/cli/OptionBuilder.java
+++ b/src/main/java/org/apache/commons/cli/OptionBuilder.java
@@ -326,7 +326,6 @@ public final class OptionBuilder {
* </pre>
*
* @param sep The value separator to be used for the argument values.
- *
* @return the OptionBuilder instance
*/
public static OptionBuilder withValueSeparator(final char sep) {
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 ea947179..057be062 100644
--- a/src/main/java/org/apache/commons/cli/help/Util.java
+++ b/src/main/java/org/apache/commons/cli/help/Util.java
@@ -107,7 +107,6 @@ final class Util {
* Creates a String of padding of length {@code len}.
*
* @param len The length of the String of padding to create.
- *
* @return The String of padding.
*/
static String repeatSpace(final int len) {
