svn commit: r746142 - /commons/proper/cli/branches/cli-1.x/src/java/org/apache/commons/cli/HelpFormatter.java

[ba...@apache.org]

Author: bayard
Date: Fri Feb 20 05:09:44 2009
New Revision: 746142

URL: http://svn.apache.org/viewvc?rev=746142&view=rev
Log:
Adding Javadoc note on IllegalStateException throwing

Modified:
    commons/proper/cli/branches/cli-1.x/src/java/org/apache/commons/cli/HelpFormatter.java

Modified: commons/proper/cli/branches/cli-1.x/src/java/org/apache/commons/cli/HelpFormatter.java
URL: http://svn.apache.org/viewvc/commons/proper/cli/branches/cli-1.x/src/java/org/apache/commons/cli/HelpFormatter.java?rev=746142&r1=746141&r2=746142&view=diff
==============================================================================
--- commons/proper/cli/branches/cli-1.x/src/java/org/apache/commons/cli/HelpFormatter.java (original)
+++ commons/proper/cli/branches/cli-1.x/src/java/org/apache/commons/cli/HelpFormatter.java Fri Feb 20 05:09:44 2009
@@ -433,6 +433,8 @@
      * @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(PrintWriter pw, int width, String cmdLineSyntax, 
                           String header, Options options, int leftPad, 
@@ -458,6 +460,8 @@
      * @param footer the banner to display at the end of the help
      * @param autoUsage whether to print an automatically generated
      * usage statement
+     *
+     * @throws IllegalStateException if there is no room to print a line
      */
     public void printHelp(PrintWriter pw, int width, String cmdLineSyntax,
                           String header, Options options, int leftPad,