svn commit: r678667 - in /commons/proper/cli/branches/cli-1.x/src/java/org/apache/commons/cli: Option.java OptionValidator.java Parser.java

[eb...@apache.org]

Author: ebourg
Date: Tue Jul 22 00:55:36 2008
New Revision: 678667

URL: http://svn.apache.org/viewvc?rev=678667&view=rev
Log:
Added the missing @since tags for the classes and methods added in CLI 1.1

Modified:
    commons/proper/cli/branches/cli-1.x/src/java/org/apache/commons/cli/Option.java
    commons/proper/cli/branches/cli-1.x/src/java/org/apache/commons/cli/OptionValidator.java
    commons/proper/cli/branches/cli-1.x/src/java/org/apache/commons/cli/Parser.java

Modified: commons/proper/cli/branches/cli-1.x/src/java/org/apache/commons/cli/Option.java
URL: http://svn.apache.org/viewvc/commons/proper/cli/branches/cli-1.x/src/java/org/apache/commons/cli/Option.java?rev=678667&r1=678666&r2=678667&view=diff
==============================================================================
--- commons/proper/cli/branches/cli-1.x/src/java/org/apache/commons/cli/Option.java (original)
+++ commons/proper/cli/branches/cli-1.x/src/java/org/apache/commons/cli/Option.java Tue Jul 22 00:55:36 2008
@@ -120,7 +120,7 @@
      * @throws IllegalArgumentException if there are any non valid
      * Option characters in <code>opt</code>.
      */
-    public Option(String opt, String longOpt, boolean hasArg, 
+    public Option(String opt, String longOpt, boolean hasArg,
                   String description)
            throws IllegalArgumentException
     {
@@ -271,10 +271,11 @@
         return this.description;
     }
 
-   /** 
+    /**
      * Sets the self-documenting description of this Option
      *
      * @param description The description of this option
+     * @since 1.1
      */
     public void setDescription(String description)
     {
@@ -340,7 +341,7 @@
      */
     public boolean hasArgs()
     {
-        return (this.numberOfArgs > 1) 
+        return (this.numberOfArgs > 1)
                 || (this.numberOfArgs == UNLIMITED_VALUES);
     }
 
@@ -379,6 +380,7 @@
      * Return whether this Option has specified a value separator.
      * 
      * @return whether this Option has specified a value separator.
+     * @since 1.1
      */
     public boolean hasValueSeparator()
     {

Modified: commons/proper/cli/branches/cli-1.x/src/java/org/apache/commons/cli/OptionValidator.java
URL: http://svn.apache.org/viewvc/commons/proper/cli/branches/cli-1.x/src/java/org/apache/commons/cli/OptionValidator.java?rev=678667&r1=678666&r2=678667&view=diff
==============================================================================
--- commons/proper/cli/branches/cli-1.x/src/java/org/apache/commons/cli/OptionValidator.java (original)
+++ commons/proper/cli/branches/cli-1.x/src/java/org/apache/commons/cli/OptionValidator.java Tue Jul 22 00:55:36 2008
@@ -20,6 +20,7 @@
  * Validates an Option string.
  *
  * @author John Keyes ( john at integralsource.com )
+ * @since 1.1
  */
 public class OptionValidator {
 
@@ -98,4 +99,4 @@
     {
         return Character.isJavaIdentifierPart(c);
     }
-}
\ No newline at end of file
+}

Modified: commons/proper/cli/branches/cli-1.x/src/java/org/apache/commons/cli/Parser.java
URL: http://svn.apache.org/viewvc/commons/proper/cli/branches/cli-1.x/src/java/org/apache/commons/cli/Parser.java?rev=678667&r1=678666&r2=678667&view=diff
==============================================================================
--- commons/proper/cli/branches/cli-1.x/src/java/org/apache/commons/cli/Parser.java (original)
+++ commons/proper/cli/branches/cli-1.x/src/java/org/apache/commons/cli/Parser.java Tue Jul 22 00:55:36 2008
@@ -97,6 +97,8 @@
      *
      * @throws ParseException if there are any problems encountered
      * while parsing the command line tokens.
+     *
+     * @since 1.1
      */
     public CommandLine parse(Options options, String[] arguments, 
                              Properties properties)
@@ -141,6 +143,8 @@
      *
      * @throws ParseException if there are any problems encountered
      * while parsing the command line tokens.
+     *
+     * @since 1.1
      */
     public CommandLine parse(Options options, String[] arguments, 
                              Properties properties, boolean stopAtNonOption)