roxspring 2004/01/13 14:01:23
Modified: cli/src/java/org/apache/commons/cli2 OptionException.java
Option.java HelpLine.java PropertyOption.java
CommandLineParser.java Comparators.java
Command.java ArgumentImpl.java
Log:
Javadoc fixes
Revision Changes Path
1.4 +3 -4
jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/OptionException.java
Index: OptionException.java
===================================================================
RCS file:
/home/cvs/jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/OptionException.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- OptionException.java 23 Oct 2003 23:09:15 -0000 1.3
+++ OptionException.java 13 Jan 2004 22:01:22 -0000 1.4
@@ -85,7 +85,6 @@
/**
* Creates a new OptionException.
* @param option The Option the exception relates to
- * @param argument The argument the exception relates to
*/
public OptionException(final Option option) {
this.option = option;
1.4 +5 -4
jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/Option.java
Index: Option.java
===================================================================
RCS file:
/home/cvs/jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/Option.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Option.java 29 Oct 2003 17:32:12 -0000 1.3
+++ Option.java 13 Jan 2004 22:01:22 -0000 1.4
@@ -83,6 +83,7 @@
*
* @param commandLine The CommandLine object to store results in
* @param args The arguments to process
+ * @throws OptionException if any problems occur
*/
public void process(final CommandLine commandLine, final ListIterator args)
throws OptionException;
@@ -91,7 +92,7 @@
* Indicates whether this Option will be able to process the particular
* argument.
*
- * @param arg The argument to be tested
+ * @param argument The argument to be tested
* @return true if the argument can be processed by this Option
*/
public boolean canProcess(final String argument);
1.2 +3 -5
jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/HelpLine.java
Index: HelpLine.java
===================================================================
RCS file:
/home/cvs/jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/HelpLine.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- HelpLine.java 18 Oct 2003 22:00:12 -0000 1.1
+++ HelpLine.java 13 Jan 2004 22:01:22 -0000 1.2
@@ -82,8 +82,6 @@
*
* @param option Option that the HelpLine describes
* @param indent Level of indentation for this line
- * @param description Description of the option
- * @param usage Usage string of the option
*/
public HelpLine(final Option option, final int indent) {
this.option = option;
1.5 +4 -3
jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/PropertyOption.java
Index: PropertyOption.java
===================================================================
RCS file:
/home/cvs/jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/PropertyOption.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- PropertyOption.java 29 Oct 2003 17:32:12 -0000 1.4
+++ PropertyOption.java 13 Jan 2004 22:01:22 -0000 1.5
@@ -150,6 +150,7 @@
* @see
org.apache.commons.cli2.Option#validate(org.apache.commons.cli2.CommandLine)
*/
public void validate(CommandLine commandLine) throws OptionException {
+ // PropertyOption needs no validation
}
/* (non-Javadoc)
1.5 +4 -4
jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/CommandLineParser.java
Index: CommandLineParser.java
===================================================================
RCS file:
/home/cvs/jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/CommandLineParser.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- CommandLineParser.java 25 Oct 2003 15:02:05 -0000 1.4
+++ CommandLineParser.java 13 Jan 2004 22:01:22 -0000 1.5
@@ -89,7 +89,7 @@
* @param arguments the command line arguments
*
* @return the list of atomic option and value tokens
- * @throws ParseException if there are any problems encountered
+ * @throws OptionException if there are any problems encountered
* while parsing the command line tokens.
*/
public CommandLine parse(final String[] arguments) throws OptionException {
1.3 +6 -3
jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/Comparators.java
Index: Comparators.java
===================================================================
RCS file:
/home/cvs/jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/Comparators.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Comparators.java 22 Oct 2003 16:32:14 -0000 1.2
+++ Comparators.java 13 Jan 2004 22:01:22 -0000 1.3
@@ -176,6 +176,7 @@
/**
* Reverses a comparator's logic.
+ * @param wrapped the Comparator to reverse the logic of
* @return a comparator with reverse logic
*/
private static Comparator reverse(final Comparator wrapped) {
@@ -336,6 +337,7 @@
/**
* Forces Comparators with a particular trigger to appear at the beginning of
lists
+ * @param name the trigger name to select
* @see Option#triggers()
* @return a new comparator
*/
@@ -345,6 +347,7 @@
/**
* Forces Comparators with a particular trigger to appear at the end of lists
+ * @param name the trigger name to select
* @see Option#triggers()
* @return a new comparator
*/
1.3 +7 -3
jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/Command.java
Index: Command.java
===================================================================
RCS file:
/home/cvs/jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/Command.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Command.java 29 Oct 2003 17:32:12 -0000 1.2
+++ Command.java 13 Jan 2004 22:01:22 -0000 1.3
@@ -96,7 +96,11 @@
* @param description A description of the Command
* @param aliases Alternative names for the Command
* @param required Whether the Command is required
+ * @param argument An Argument that the command takes
* @param children The Group of child options for this Command
+ * @param id A unique id for the Command
+ *
+ * @see ParentImpl#ParentImpl(Argument, Group, String, int)
*/
protected Command(
final String preferredName,
1.11 +6 -3
jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/ArgumentImpl.java
Index: ArgumentImpl.java
===================================================================
RCS file:
/home/cvs/jakarta-commons-sandbox/cli/src/java/org/apache/commons/cli2/ArgumentImpl.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- ArgumentImpl.java 31 Oct 2003 23:12:01 -0000 1.10
+++ ArgumentImpl.java 13 Jan 2004 22:01:22 -0000 1.11
@@ -102,9 +102,12 @@
* @param maximum The maximum number of values allowed to be valid
* @param initialSeparator The char separating option from value
* @param subsequentSeparator The char separating values from each other
+ * @param validator The object responsible for validating the values
* @param consumeRemaining The String used for the "consuming option" group
* @param defaultValues The values to be used if none are specified.
* @param id The id of the option, 0 implies automatic assignment.
+ *
+ * @see OptionImpl#OptionImpl(int)
*/
public ArgumentImpl(
final String name,
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
