Author: sgoeschl
Date: Mon Jan 12 08:53:15 2009
New Revision: 733838
URL: http://svn.apache.org/viewvc?rev=733838&view=rev
Log:
Some cosmetic javadoc fixes to make reviewers happy
Modified:
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/Option.java
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/builder/ArgumentBuilder.java
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/builder/CommandBuilder.java
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/builder/DefaultOptionBuilder.java
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/builder/GroupBuilder.java
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/builder/PatternBuilder.java
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/builder/SwitchBuilder.java
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/commandline/Parser.java
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/validation/ClassValidator.java
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/validation/UrlValidator.java
Modified: commons/proper/cli/trunk/src/java/org/apache/commons/cli2/Option.java
URL:
http://svn.apache.org/viewvc/commons/proper/cli/trunk/src/java/org/apache/commons/cli2/Option.java?rev=733838&r1=733837&r2=733838&view=diff
==============================================================================
--- commons/proper/cli/trunk/src/java/org/apache/commons/cli2/Option.java
(original)
+++ commons/proper/cli/trunk/src/java/org/apache/commons/cli2/Option.java Mon
Jan 12 08:53:15 2009
@@ -62,6 +62,8 @@
* 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 @@
* 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
Modified:
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/builder/ArgumentBuilder.java
URL:
http://svn.apache.org/viewvc/commons/proper/cli/trunk/src/java/org/apache/commons/cli2/builder/ArgumentBuilder.java?rev=733838&r1=733837&r2=733838&view=diff
==============================================================================
---
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/builder/ArgumentBuilder.java
(original)
+++
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/builder/ArgumentBuilder.java
Mon Jan 12 08:53:15 2009
@@ -99,6 +99,7 @@
/**
* 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";
Modified:
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/builder/CommandBuilder.java
URL:
http://svn.apache.org/viewvc/commons/proper/cli/trunk/src/java/org/apache/commons/cli2/builder/CommandBuilder.java?rev=733838&r1=733837&r2=733838&view=diff
==============================================================================
---
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/builder/CommandBuilder.java
(original)
+++
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/builder/CommandBuilder.java
Mon Jan 12 08:53:15 2009
@@ -84,6 +84,7 @@
*
* This method is called automatically at the end of the
* {...@link #create() create} method.
+ * @return this <code>CommandBuilder</code>
*/
public CommandBuilder reset() {
preferredName = null;
Modified:
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/builder/DefaultOptionBuilder.java
URL:
http://svn.apache.org/viewvc/commons/proper/cli/trunk/src/java/org/apache/commons/cli2/builder/DefaultOptionBuilder.java?rev=733838&r1=733837&r2=733838&view=diff
==============================================================================
---
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/builder/DefaultOptionBuilder.java
(original)
+++
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/builder/DefaultOptionBuilder.java
Mon Jan 12 08:53:15 2009
@@ -99,7 +99,8 @@
}
/**
- * Resets the builder
+ * Resets the builder.
+ * @return this builder
*/
public DefaultOptionBuilder reset() {
preferredName = null;
Modified:
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/builder/GroupBuilder.java
URL:
http://svn.apache.org/viewvc/commons/proper/cli/trunk/src/java/org/apache/commons/cli2/builder/GroupBuilder.java?rev=733838&r1=733837&r2=733838&view=diff
==============================================================================
---
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/builder/GroupBuilder.java
(original)
+++
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/builder/GroupBuilder.java
Mon Jan 12 08:53:15 2009
@@ -56,7 +56,8 @@
}
/**
- * Resets the builder
+ * Resets the builder.
+ * @return this builder
*/
public GroupBuilder reset() {
name = null;
@@ -69,7 +70,7 @@
}
/**
- * Use this option description
+ * Use this option description.
* @param newDescription the description to use
* @return this builder
*/
Modified:
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/builder/PatternBuilder.java
URL:
http://svn.apache.org/viewvc/commons/proper/cli/trunk/src/java/org/apache/commons/cli2/builder/PatternBuilder.java?rev=733838&r1=733837&r2=733838&view=diff
==============================================================================
---
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/builder/PatternBuilder.java
(original)
+++
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/builder/PatternBuilder.java
Mon Jan 12 08:53:15 2009
@@ -90,7 +90,8 @@
}
/**
- * Resets this builder
+ * Resets this builder.
+ * @return this builder
*/
public PatternBuilder reset() {
options.clear();
Modified:
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/builder/SwitchBuilder.java
URL:
http://svn.apache.org/viewvc/commons/proper/cli/trunk/src/java/org/apache/commons/cli2/builder/SwitchBuilder.java?rev=733838&r1=733837&r2=733838&view=diff
==============================================================================
---
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/builder/SwitchBuilder.java
(original)
+++
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/builder/SwitchBuilder.java
Mon Jan 12 08:53:15 2009
@@ -91,7 +91,8 @@
}
/**
- * Resets the builder
+ * Resets the builder.
+ * @return this builder
*/
public SwitchBuilder reset() {
description = null;
Modified:
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/commandline/Parser.java
URL:
http://svn.apache.org/viewvc/commons/proper/cli/trunk/src/java/org/apache/commons/cli2/commandline/Parser.java?rev=733838&r1=733837&r2=733838&view=diff
==============================================================================
---
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/commandline/Parser.java
(original)
+++
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/commandline/Parser.java
Mon Jan 12 08:53:15 2009
@@ -114,7 +114,6 @@
*
* @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);
Modified:
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/validation/ClassValidator.java
URL:
http://svn.apache.org/viewvc/commons/proper/cli/trunk/src/java/org/apache/commons/cli2/validation/ClassValidator.java?rev=733838&r1=733837&r2=733838&view=diff
==============================================================================
---
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/validation/ClassValidator.java
(original)
+++
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/validation/ClassValidator.java
Mon Jan 12 08:53:15 2009
@@ -172,6 +172,8 @@
/**
* 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();
Modified:
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/validation/UrlValidator.java
URL:
http://svn.apache.org/viewvc/commons/proper/cli/trunk/src/java/org/apache/commons/cli2/validation/UrlValidator.java?rev=733838&r1=733837&r2=733838&view=diff
==============================================================================
---
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/validation/UrlValidator.java
(original)
+++
commons/proper/cli/trunk/src/java/org/apache/commons/cli2/validation/UrlValidator.java
Mon Jan 12 08:53:15 2009
@@ -61,6 +61,7 @@
/**
* Creates a UrlValidator for the specified protocol.
+ * @param protocol the protocol to be used
*/
public UrlValidator(final String protocol) {
setProtocol(protocol);
