commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From tobr...@apache.org
Subject cvs commit: jakarta-commons/cli/src/java/org/apache/commons/cli HelpFormatter.java
Date Mon, 11 Aug 2003 14:01:47 GMT
tobrien     2003/08/11 07:01:47

  Modified:    cli/src/java/org/apache/commons/cli HelpFormatter.java
  Log:
  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.
  
  Revision  Changes    Path
  1.13      +13 -7     jakarta-commons/cli/src/java/org/apache/commons/cli/HelpFormatter.java
  
  Index: HelpFormatter.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/cli/src/java/org/apache/commons/cli/HelpFormatter.java,v
  retrieving revision 1.12
  retrieving revision 1.13
  diff -u -r1.12 -r1.13
  --- HelpFormatter.java	9 Dec 2002 23:47:24 -0000	1.12
  +++ HelpFormatter.java	11 Aug 2003 14:01:47 -0000	1.13
  @@ -290,7 +290,8 @@
   
       /**
        * <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 @@
   
       /**
        * <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 @@
   
       /**
        * <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 @@
   
       /**
        * <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 @@
   
       /**
        * <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 @@
   
       /**
        * <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 @@
               return strOption.substring(iStartIndex);
           }
       }
  -}
  \ No newline at end of file
  +}
  
  
  

Mime
View raw message