Skip to content

Commit eeb83e4

Browse files
committed
Adding Javadoc note on IllegalStateException throwing
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/cli/branches/cli-1.x@746142 13f79535-47bb-0310-9956-ffa450edef68
1 parent 84234a6 commit eeb83e4

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -433,6 +433,8 @@ public void printHelp(int width, String cmdLineSyntax, String header,
433433
* @param descPad the number of characters of padding to be prefixed
434434
* to each description line
435435
* @param footer the banner to display at the end of the help
436+
*
437+
* @throws IllegalStateException if there is no room to print a line
436438
*/
437439
public void printHelp(PrintWriter pw, int width, String cmdLineSyntax,
438440
String header, Options options, int leftPad,
@@ -458,6 +460,8 @@ public void printHelp(PrintWriter pw, int width, String cmdLineSyntax,
458460
* @param footer the banner to display at the end of the help
459461
* @param autoUsage whether to print an automatically generated
460462
* usage statement
463+
*
464+
* @throws IllegalStateException if there is no room to print a line
461465
*/
462466
public void printHelp(PrintWriter pw, int width, String cmdLineSyntax,
463467
String header, Options options, int leftPad,

0 commit comments

Comments
 (0)