Javadoc

Reduce vertical whitespace

Author: garydgregory

src/main/java/org/apache/commons/cli/help/AbstractHelpFormatter.java

@@ -187,7 +187,7 @@ public B setOptionGroupSeparator(final String optionGroupSeparator) {
     private final HelpAppendable helpAppendable;
 
     /**
-     * The OptionFormatter.Builder used to display options within the help page
+     * The OptionFormatter.Builder used to display options within the help page.
      */
     private final OptionFormatter.Builder optionFormatBuilder;
 
@@ -202,7 +202,7 @@ public B setOptionGroupSeparator(final String optionGroupSeparator) {
     /**
      * Constructs the base formatter.
      *
-     * @param builder the builder
+     * @param builder the builder.
      */
     protected AbstractHelpFormatter(final Builder<?, ?> builder) {
         this.helpAppendable = Objects.requireNonNull(builder.getHelpAppendable(), "helpAppendable");
@@ -286,12 +286,12 @@ public final String getSyntaxPrefix() {
     /**
      * Prints the help for a collection of {@link Option}s with the specified command line syntax.
      *
-     * @param cmdLineSyntax the syntax for this application
-     * @param header        the banner to display at the beginning of the help
+     * @param cmdLineSyntax the syntax for this application.
+     * @param header        the banner to display at the beginning of the help.
      * @param options       the collection of {@link Option} objects to print.
-     * @param footer        the banner to display at the end of the help
-     * @param autoUsage     whether to print an automatically generated usage statement
-     * @throws IOException If the output could not be written to the {@link HelpAppendable}
+     * @param footer        the banner to display at the end of the help.
+     * @param autoUsage     whether to print an automatically generated usage statement.
+     * @throws IOException If the output could not be written to the {@link HelpAppendable}.
      */
     public void printHelp(final String cmdLineSyntax, final String header, final Iterable<Option> options, final String footer, final boolean autoUsage)
             throws IOException {
@@ -315,12 +315,12 @@ public void printHelp(final String cmdLineSyntax, final String header, final Ite
     /**
      * Prints the help for {@link Options} with the specified command line syntax.
      *
-     * @param cmdLineSyntax the syntax for this application
-     * @param header        the banner to display at the beginning of the help
-     * @param options       the {@link Options} to print
-     * @param footer        the banner to display at the end of the help
-     * @param autoUsage     whether to print an automatically generated usage statement
-     * @throws IOException If the output could not be written to the {@link HelpAppendable}
+     * @param cmdLineSyntax the syntax for this application.
+     * @param header        the banner to display at the beginning of the help.
+     * @param options       the {@link Options} to print.
+     * @param footer        the banner to display at the end of the help.
+     * @param autoUsage     whether to print an automatically generated usage statement.
+     * @throws IOException If the output could not be written to the {@link HelpAppendable}.
      */
     public final void printHelp(final String cmdLineSyntax, final String header, final Options options, final String footer, final boolean autoUsage)
             throws IOException {
@@ -331,7 +331,7 @@ public final void printHelp(final String cmdLineSyntax, final String header, fin
      * Prints the option table for a collection of {@link Option} objects to the {@link HelpAppendable}.
      *
      * @param options the collection of Option objects to print in the table.
-     * @throws IOException If the output could not be written to the {@link HelpAppendable}
+     * @throws IOException If the output could not be written to the {@link HelpAppendable}.
      */
     public final void printOptions(final Iterable<Option> options) throws IOException {
         printOptions(getTableDefinition(options));
@@ -341,7 +341,7 @@ public final void printOptions(final Iterable<Option> options) throws IOExceptio
      * Prints the option table for the specified {@link Options} to the {@link HelpAppendable}.
      *
      * @param options the Options to print in the table.
-     * @throws IOException If the output could not be written to the {@link HelpAppendable}
+     * @throws IOException If the output could not be written to the {@link HelpAppendable}.
      */
     public final void printOptions(final Options options) throws IOException {
         printOptions(options.getOptions());
@@ -351,7 +351,7 @@ public final void printOptions(final Options options) throws IOException {
      * Prints a {@link TableDefinition} to the {@link HelpAppendable}.
      *
      * @param tableDefinition the {@link TableDefinition} to print.
-     * @throws IOException If the output could not be written to the {@link HelpAppendable}
+     * @throws IOException If the output could not be written to the {@link HelpAppendable}.
      */
     public final void printOptions(final TableDefinition tableDefinition) throws IOException {
         helpAppendable.appendTable(tableDefinition);
@@ -392,7 +392,7 @@ public List<Option> sort(final Options options) {
     }
 
     /**
-     * Formats the {@code argName} as an argument a defined in the enclosed {@link OptionFormatter.Builder}
+     * 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.

src/main/java/org/apache/commons/cli/help/OptionFormatter.java

@@ -317,22 +317,22 @@ public static OptionFormatter from(final Option option) {
      */
     private final String[] argNameDelimiters;
 
-    /** The default argument name */
+    /** The default argument name. */
     private final String defaultArgName;
 
-    /** The function to display the deprecated option message */
+    /** The function to display the deprecated option message. */
     private final Function<Option, String> deprecatedFormatFunction;
 
-    /** The prefix for the long option text */
+    /** The prefix for the long option text. */
     private final String longOptPrefix;
 
-    /** The prefix for the short option text */
+    /** The prefix for the short option text. */
     private final String optPrefix;
 
-    /** The separator between the options */
+    /** The separator between the options. */
     private final String optSeparator;
 
-    /** the separator between the opt and/or longOpt and the argument name */
+    /** the separator between the opt and/or longOpt and the argument name. */
     private final String optArgSeparator;
 
     /** The delimiters for optional {@link Option}s. */
@@ -341,7 +341,7 @@ public static OptionFormatter from(final Option option) {
     /** The method to convert an Option formatter into a syntax notation. */
     private final BiFunction<OptionFormatter, Boolean, String> syntaxFormatFunction;
 
-    /** The {@link Option} being formatted */
+    /** The {@link Option} being formatted. */
     private final Option option;
 
     /**

src/main/java/org/apache/commons/cli/help/Util.java

@@ -32,7 +32,7 @@ final class Util {
     /**
      * Returns the {@code defaultValue} if {@code str} is empty.
      *
-     * @param str          The string to check
+     * @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,