You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2024/04/08 13:13:20 UTC

(commons-cli) 10/12: Javadoc

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

commit db8c8281d3a540f385c65bbc82cddab971ffb8db
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Mon Apr 8 09:09:49 2024 -0400

    Javadoc
---
 .../java/org/apache/commons/cli/HelpFormatter.java | 24 +++++++++++-----------
 1 file changed, 12 insertions(+), 12 deletions(-)

diff --git a/src/main/java/org/apache/commons/cli/HelpFormatter.java b/src/main/java/org/apache/commons/cli/HelpFormatter.java
index e445e1e..4979583 100644
--- a/src/main/java/org/apache/commons/cli/HelpFormatter.java
+++ b/src/main/java/org/apache/commons/cli/HelpFormatter.java
@@ -313,7 +313,7 @@ public class HelpFormatter {
     }
 
     /**
-     * Return a String of padding of length {@code len}.
+     * Creates a String of padding of length {@code len}.
      *
      * @param len The length of the String of padding to create.
      *
@@ -459,7 +459,7 @@ public class HelpFormatter {
     }
 
     /**
-     * Print the help for {@code options} with the specified command line syntax. This method prints help information
+     * Prints the help for {@code options} with the specified command line syntax. This method prints help information
      * to System.out.
      *
      * @param width the number of characters to be displayed on each line
@@ -473,7 +473,7 @@ public class HelpFormatter {
     }
 
     /**
-     * Print the help for {@code options} with the specified command line syntax. This method prints help information
+     * Prints the help for {@code options} with the specified command line syntax. This method prints help information
      * to System.out.
      *
      * @param width the number of characters to be displayed on each line
@@ -491,7 +491,7 @@ public class HelpFormatter {
     }
 
     /**
-     * Print the help for {@code options} with the specified command line syntax.
+     * Prints the help for {@code options} with the specified command line syntax.
      *
      * @param pw the writer to which the help will be written
      * @param width the number of characters to be displayed on each line
@@ -510,7 +510,7 @@ public class HelpFormatter {
     }
 
     /**
-     * Print the help for {@code options} with the specified command line syntax.
+     * Prints the help for {@code options} with the specified command line syntax.
      *
      * @param pw the writer to which the help will be written
      * @param width the number of characters to be displayed on each line
@@ -544,7 +544,7 @@ public class HelpFormatter {
     }
 
     /**
-     * Print the help for {@code options} with the specified command line syntax. This method prints help information
+     * Prints the help for {@code options} with the specified command line syntax. This method prints help information
      * to System.out.
      *
      * @param cmdLineSyntax the syntax for this application
@@ -555,7 +555,7 @@ public class HelpFormatter {
     }
 
     /**
-     * Print the help for {@code options} with the specified command line syntax. This method prints help information
+     * Prints the help for {@code options} with the specified command line syntax. This method prints help information
      * to System.out.
      *
      * @param cmdLineSyntax the syntax for this application
@@ -567,7 +567,7 @@ public class HelpFormatter {
     }
 
     /**
-     * Print the help for {@code options} with the specified command line syntax. This method prints help information
+     * Prints the help for {@code options} with the specified command line syntax. This method prints help information
      * to System.out.
      *
      * @param cmdLineSyntax the syntax for this application
@@ -580,7 +580,7 @@ public class HelpFormatter {
     }
 
     /**
-     * Print the help for {@code options} with the specified command line syntax. This method prints help information
+     * Prints the help for {@code options} with the specified command line syntax. This method prints help information
      * to System.out.
      *
      * @param cmdLineSyntax the syntax for this application
@@ -594,7 +594,7 @@ public class HelpFormatter {
     }
 
     /**
-     * Print the help for the specified Options to the specified writer, using the specified width, left padding and
+     * Prints the help for the specified Options to the specified writer, using the specified width, left padding and
      * description padding.
      *
      * @param pw The printWriter to write the help to
@@ -610,7 +610,7 @@ public class HelpFormatter {
     }
 
     /**
-     * Print the cmdLineSyntax to the specified writer, using the specified width.
+     * Prints the cmdLineSyntax to the specified writer, using the specified width.
      *
      * @param pw The printWriter to write the help to
      * @param width The number of characters per line for the usage statement.
@@ -670,7 +670,7 @@ public class HelpFormatter {
     }
 
     /**
-     * Print the specified text to the specified PrintWriter.
+     * Prints the specified text to the specified PrintWriter.
      *
      * @param pw The printWriter to write the help to
      * @param width The number of characters to display per line