svn commit: r779077 - in /commons/proper/cli/trunk/src/java/org/apache/commons/cli: CommandLine.java HelpFormatter.java

[eb...@apache.org]

Author: ebourg
Date: Wed May 27 10:13:36 2009
New Revision: 779077

URL: http://svn.apache.org/viewvc?rev=779077&view=rev
Log:
Added missing @since tags

Modified:
    commons/proper/cli/trunk/src/java/org/apache/commons/cli/CommandLine.java
    commons/proper/cli/trunk/src/java/org/apache/commons/cli/HelpFormatter.java

Modified: commons/proper/cli/trunk/src/java/org/apache/commons/cli/CommandLine.java
URL: http://svn.apache.org/viewvc/commons/proper/cli/trunk/src/java/org/apache/commons/cli/CommandLine.java?rev=779077&r1=779076&r2=779077&view=diff
==============================================================================
--- commons/proper/cli/trunk/src/java/org/apache/commons/cli/CommandLine.java (original)
+++ commons/proper/cli/trunk/src/java/org/apache/commons/cli/CommandLine.java Wed May 27 10:13:36 2009
@@ -105,6 +105,7 @@
      * @return the value parsed into a particluar object
      * @throws ParseException if there are problems turning the option value into the desired type
      * @see PatternOptionBuilder
+     * @since 1.2
      */
     public Object getParsedOptionValue(String opt) throws ParseException
     {
@@ -118,7 +119,7 @@
 
         Object type = option.getType();
 
-        return (res == null)        ? null : TypeHandler.createValue(res, type);
+        return (res == null) ? null : TypeHandler.createValue(res, type);
     }
 
     /**

Modified: commons/proper/cli/trunk/src/java/org/apache/commons/cli/HelpFormatter.java
URL: http://svn.apache.org/viewvc/commons/proper/cli/trunk/src/java/org/apache/commons/cli/HelpFormatter.java?rev=779077&r1=779076&r2=779077&view=diff
==============================================================================
--- commons/proper/cli/trunk/src/java/org/apache/commons/cli/HelpFormatter.java (original)
+++ commons/proper/cli/trunk/src/java/org/apache/commons/cli/HelpFormatter.java Wed May 27 10:13:36 2009
@@ -303,9 +303,10 @@
     }
 
     /**
-     * Comparator used to sort the options when they output in help text
+     * Comparator used to sort the options when they output in help text.
+     * Defaults to case-insensitive alphabetical sorting by option key.
      * 
-     * Defaults to case-insensitive alphabetical sorting by option key
+     * @since 1.2
      */
     public Comparator getOptionComparator()
     {
@@ -313,9 +314,10 @@
     }
 
     /**
-     * Set the comparator used to sort the options when they output in help text
+     * Set the comparator used to sort the options when they output in help text.
+     * Passing in a null parameter will set the ordering to the default mode.
      * 
-     * Passing in a null parameter will set the ordering to the default mode
+     * @since 1.2
      */
     public void setOptionComparator(Comparator comparator)
     {