Some cosmetic javadoc fixes to make reviewers happy

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

Author: Siegfried Goeschl

src/java/org/apache/commons/cli2/Option.java

@@ -62,6 +62,8 @@ void process(
      * Indicates whether this Option will be able to process the particular
      * argument.
      *
+     * @param commandLine
+     *            The CommandLine to check
      * @param argument
      *            The argument to be tested
      * @return true if the argument can be processed by this Option
@@ -74,6 +76,8 @@ void process(
      * returning the boolean.
      *
      * @see #canProcess(WriteableCommandLine,String)
+     * @param commandLine
+     *            the CommandLine to check
      * @param arguments
      *            the ListIterator over String arguments
      * @return true if the argument can be processed by this Option

src/java/org/apache/commons/cli2/builder/ArgumentBuilder.java

@@ -99,6 +99,7 @@ public final Argument create() {
     /**
      * Resets the ArgumentBuilder to the defaults for a new Argument. The
      * method is called automatically at the end of a create() call.
+     * @return this ArgumentBuilder
      */
     public final ArgumentBuilder reset() {
         name = "arg";

src/java/org/apache/commons/cli2/builder/CommandBuilder.java

@@ -84,6 +84,7 @@ public Command create() {
      *
      * This method is called automatically at the end of the
      * {@link #create() create} method.
+     * @return this <code>CommandBuilder</code>
      */
     public CommandBuilder reset() {
         preferredName = null;

src/java/org/apache/commons/cli2/builder/DefaultOptionBuilder.java

@@ -99,7 +99,8 @@ public DefaultOption create()
     }
 
     /**
-     * Resets the builder
+     * Resets the builder.
+     * @return this builder
      */
     public DefaultOptionBuilder reset() {
         preferredName = null;

src/java/org/apache/commons/cli2/builder/GroupBuilder.java

@@ -56,7 +56,8 @@ public Group create() {
     }
 
     /**
-     * Resets the builder
+     * Resets the builder.
+     * @return this builder     
      */
     public GroupBuilder reset() {
         name = null;
@@ -69,7 +70,7 @@ public GroupBuilder reset() {
     }
 
     /**
-     * Use this option description
+     * Use this option description.
      * @param newDescription the description to use
      * @return this builder
      */

src/java/org/apache/commons/cli2/builder/PatternBuilder.java

@@ -90,7 +90,8 @@ public Option create() {
     }
 
     /**
-     * Resets this builder
+     * Resets this builder.
+     * @return this builder
      */
     public PatternBuilder reset() {
         options.clear();

src/java/org/apache/commons/cli2/builder/SwitchBuilder.java

@@ -91,7 +91,8 @@ public Switch create() {
     }
 
     /**
-     * Resets the builder
+     * Resets the builder.
+     * @return this builder
      */
     public SwitchBuilder reset() {
         description = null;

src/java/org/apache/commons/cli2/commandline/Parser.java

@@ -114,7 +114,6 @@ public CommandLine parse(final String[] arguments)
      *
      * @param arguments the command line arguments
      * @return a valid CommandLine or null if the parse was unsuccessful
-     * @throws IOException if an error occurs while formatting help
      */
     public CommandLine parseAndHelp(final String[] arguments) {
         helpFormatter.setGroup(group);

src/java/org/apache/commons/cli2/validation/ClassValidator.java

@@ -172,6 +172,8 @@ public void setInstance(boolean instance) {
     /**
      * Returns whether the specified name is allowed as
      * a Java class name.
+     * @param name the name to be checked
+     * @return true if allowed as Java class name
      */
     protected boolean isPotentialClassName(final String name) {
         final char[] chars = name.toCharArray();

src/java/org/apache/commons/cli2/validation/UrlValidator.java

@@ -61,6 +61,7 @@ public UrlValidator() {
 
     /**
      * Creates a UrlValidator for the specified protocol.
+     * @param protocol the protocol to be used
      */
     public UrlValidator(final String protocol) {
         setProtocol(protocol);