Added a trivial amount of Javadoc to the HelpFormatter. The writerless printHelp function assumed that a user would know that information was being printed to System.out. It makes sense to explicitly state this.

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/cli/trunk@129945 13f79535-47bb-0310-9956-ffa450edef68

Author: Timothy O'Brien

src/java/org/apache/commons/cli/HelpFormatter.java

@@ -290,7 +290,8 @@ public String getArgName()
 
     /**
      * <p>Print the help for <code>options</code> with the specified
-     * command line syntax.</p>
+     * command line syntax.  This method prints help information to
+     * System.out.</p>
      *
      * @param cmdLineSyntax the syntax for this application
      * @param options the Options instance
@@ -302,7 +303,8 @@ public void printHelp(String cmdLineSyntax, Options options)
 
     /**
      * <p>Print the help for <code>options</code> with the specified
-     * command line syntax.</p>
+     * command line syntax.  This method prints help information to 
+     * System.out.</p>
      *
      * @param cmdLineSyntax the syntax for this application
      * @param options the Options instance
@@ -317,7 +319,8 @@ public void printHelp(String cmdLineSyntax, Options options,
 
     /**
      * <p>Print the help for <code>options</code> with the specified
-     * command line syntax.</p>
+     * command line syntax.  This method prints help information to
+     * System.out.</p>
      *
      * @param cmdLineSyntax the syntax for this application
      * @param header the banner to display at the begining of the help
@@ -332,7 +335,8 @@ public void printHelp(String cmdLineSyntax, String header, Options options,
 
     /**
      * <p>Print the help for <code>options</code> with the specified
-     * command line syntax.</p>
+     * command line syntax.  This method prints help information to 
+     * System.out.</p>
      *
      * @param cmdLineSyntax the syntax for this application
      * @param header the banner to display at the begining of the help
@@ -350,7 +354,8 @@ public void printHelp(String cmdLineSyntax, String header, Options options,
 
     /**
      * <p>Print the help for <code>options</code> with the specified
-     * command line syntax.</p>
+     * command line syntax.  This method prints help information to
+     * System.out.</p>
      *
      * @param width the number of characters to be displayed on each line
      * @param cmdLineSyntax the syntax for this application
@@ -366,7 +371,8 @@ public void printHelp(int width, String cmdLineSyntax, String header,
 
     /**
      * <p>Print the help for <code>options</code> with the specified
-     * command line syntax.</p>
+     * command line syntax.  This method prints help information to
+     * System.out.</p>
      *
      * @param width the number of characters to be displayed on each line
      * @param cmdLineSyntax the syntax for this application
@@ -970,4 +976,4 @@ private String stripPrefix(String strOption)
             return strOption.substring(iStartIndex);
         }
     }
-}
+}