Improved the javadoc explaining the stopAtNonOption parameter

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

Author: ebourg

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

@@ -63,8 +63,10 @@ CommandLine parse(Options options, String[] arguments, Properties properties)
      *
      * @param options the specified Options
      * @param arguments the command line arguments
-     * @param stopAtNonOption specifies whether to continue parsing the
-     * arguments if a non option is encountered.
+     * @param stopAtNonOption if <tt>true</tt> an unrecognized argument stops
+     *     the parsing and the remaining arguments are added to the 
+     *     {@link CommandLine}s args list. If <tt>false</tt> an unrecognized
+     *     argument triggers a ParseException.
      *
      * @return the list of atomic option and value tokens
      * @throws ParseException if there are any problems encountered
@@ -79,7 +81,10 @@ CommandLine parse(Options options, String[] arguments, Properties properties)
      * @param options the specified Options
      * @param arguments the command line arguments
      * @param properties command line option name-value pairs
-     * @param stopAtNonOption specifies whether to continue parsing the
+     * @param stopAtNonOption if <tt>true</tt> an unrecognized argument stops
+     *     the parsing and the remaining arguments are added to the 
+     *     {@link CommandLine}s args list. If <tt>false</tt> an unrecognized
+     *     argument triggers a ParseException.
      *
      * @return the list of atomic option and value tokens
      * @throws ParseException if there are any problems encountered

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

@@ -32,8 +32,14 @@ public class DefaultParser implements CommandLineParser
 {    
     protected CommandLine cmd;
     protected Options options;
+
+    /** 
+     * Flag indicating how unrecognized tokens are handled. <tt>true</tt> to stop
+     * the parsing and add the remaining tokens to the args list.
+     * <tt>false</tt> to throw an exception. 
+     */
     protected boolean stopAtNonOption;
-    
+
     /** The token currently processed. */
     protected String currentToken;
 
@@ -251,7 +257,7 @@ private void handleUnknownToken(String token) throws ParseException
         if (stopAtNonOption)
         {
             skipParsing = true;
-        }        
+        }
     }
 
     /**

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

@@ -108,9 +108,10 @@ public CommandLine parse(Options options, String[] arguments, Properties propert
      *
      * @param options         the <code>Options</code>
      * @param arguments       the <code>arguments</code>
-     * @param stopAtNonOption specifies whether to stop interpreting the
-     *                        arguments when a non option has been encountered
-     *                        and to add them to the CommandLines args list.
+     * @param stopAtNonOption if <tt>true</tt> an unrecognized argument stops
+     *     the parsing and the remaining arguments are added to the 
+     *     {@link CommandLine}s args list. If <tt>false</tt> an unrecognized
+     *     argument triggers a ParseException.
      * @return the <code>CommandLine</code>
      * @throws ParseException if an error occurs when parsing the arguments.
      */
@@ -126,8 +127,10 @@ public CommandLine parse(Options options, String[] arguments, boolean stopAtNonO
      * @param options the specified Options
      * @param arguments the command line arguments
      * @param properties command line option name-value pairs
-     * @param stopAtNonOption stop parsing the arguments when the first
-     * non option is encountered.
+     * @param stopAtNonOption if <tt>true</tt> an unrecognized argument stops
+     *     the parsing and the remaining arguments are added to the 
+     *     {@link CommandLine}s args list. If <tt>false</tt> an unrecognized
+     *     argument triggers a ParseException.
      *
      * @return the list of atomic option and value tokens
      *