[Japi-cvs] SF.net SVN: japi:[1280] libs/argparser/trunk/src/prj/net/sf/japi/io/args

[<chr...@us...>]

Revision: 1280
          http://japi.svn.sourceforge.net/japi/?rev=1280&view=rev
Author:   christianhujer
Date:     2009-05-09 22:14:21 +0000 (Sat, 09 May 2009)

Log Message:
-----------
Documentation improvements.

Modified Paths:
--------------
    libs/argparser/trunk/src/prj/net/sf/japi/io/args/MethodOptionComparator.java
    libs/argparser/trunk/src/prj/net/sf/japi/io/args/Option.java
    libs/argparser/trunk/src/prj/net/sf/japi/io/args/TokenReader.java

Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/MethodOptionComparator.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/MethodOptionComparator.java	2009-05-09 22:13:29 UTC (rev 1279)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/MethodOptionComparator.java	2009-05-09 22:14:21 UTC (rev 1280)
@@ -24,7 +24,7 @@
 import java.util.Comparator;
 import org.jetbrains.annotations.NotNull;
 
-/** Compares methods by their options.
+/** Compares methods by their {@link Option}s.
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
  * @since 0.2
  */

Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/Option.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/Option.java	2009-05-09 22:13:29 UTC (rev 1279)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/Option.java	2009-05-09 22:14:21 UTC (rev 1280)
@@ -61,6 +61,7 @@
      * Default is <code>""</code> (empty String) which is interpreted as the associated method's name being the key.
      * @return option key
      */
+    // Cannot be null instead of "" because null is not interpreted as a constant here.
     String key() default "";
 
 } // @interface Option

Modified: libs/argparser/trunk/src/prj/net/sf/japi/io/args/TokenReader.java
===================================================================
--- libs/argparser/trunk/src/prj/net/sf/japi/io/args/TokenReader.java	2009-05-09 22:13:29 UTC (rev 1279)
+++ libs/argparser/trunk/src/prj/net/sf/japi/io/args/TokenReader.java	2009-05-09 22:14:21 UTC (rev 1280)
@@ -183,7 +183,7 @@
         /** String Escape - \ inside "". */
         STRING_ESCAPE,
 
-        /** Secape - after \ but outside "". */
+        /** Escape - after \ but outside "". */
         ESCAPE,
 
         /** String - inside ''. */


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.