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

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

Revision: 533
          http://svn.sourceforge.net/japi/?rev=533&view=rev
Author:   christianhujer
Date:     2007-07-13 13:17:32 -0700 (Fri, 13 Jul 2007)

Log Message:
-----------
Improved test documentation. The text about what a test does now is more clear.

Modified Paths:
--------------
    libs/argparser/trunk/src/test/net/sf/japi/io/args/ArgParserTest.java
    libs/argparser/trunk/src/test/net/sf/japi/io/args/BasicCommandTest.java
    libs/argparser/trunk/src/test/net/sf/japi/io/args/MethodOptionComparatorTest.java
    libs/argparser/trunk/src/test/net/sf/japi/io/args/MissingArgumentExceptionTest.java
    libs/argparser/trunk/src/test/net/sf/japi/io/args/OptionTypeTest.java
    libs/argparser/trunk/src/test/net/sf/japi/io/args/RequiredOptionsMissingExceptionTest.java
    libs/argparser/trunk/src/test/net/sf/japi/io/args/StringJoinerTest.java
    libs/argparser/trunk/src/test/net/sf/japi/io/args/TerminalExceptionTest.java
    libs/argparser/trunk/src/test/net/sf/japi/io/args/UnknownOptionExceptionTest.java

Modified: libs/argparser/trunk/src/test/net/sf/japi/io/args/ArgParserTest.java
===================================================================
--- libs/argparser/trunk/src/test/net/sf/japi/io/args/ArgParserTest.java	2007-07-13 20:14:47 UTC (rev 532)
+++ libs/argparser/trunk/src/test/net/sf/japi/io/args/ArgParserTest.java	2007-07-13 20:17:32 UTC (rev 533)
@@ -42,7 +42,7 @@
 public class ArgParserTest {
 
     /**
-     * Tests whether {@link ArgParser#getOptionMethods(Command)} works.
+     * Tests that {@link ArgParser#getOptionMethods(Command)} works.
      * @throws Exception (unexpected)
      */
     @Test
@@ -53,7 +53,7 @@
     }
 
     /**
-     * Tests whether {@link ArgParser#getOptionMethods(Class)} works.
+     * Tests that {@link ArgParser#getOptionMethods(Class)} works.
      * @throws Exception (unexpected)
      */
     @Test
@@ -63,7 +63,7 @@
     }
 
     /**
-     * Tests whether {@link ArgParser#simpleParseAndRun(Command, String[])} works.
+     * Tests that {@link ArgParser#simpleParseAndRun(Command, String[])} works.
      * @throws Exception (unexpected)
      */
     @Test
@@ -73,7 +73,7 @@
     }
 
     /**
-     * Tests whether {@link ArgParser#parseAndRun(Command, String[])} works.
+     * Tests that {@link ArgParser#parseAndRun(Command, String[])} works.
      * @throws Exception (unexpected)
      */
     @Test
@@ -83,7 +83,7 @@
     }
 
     /**
-     * Tests whether supplying a required option with argument in short form works.
+     * Tests that supplying a required option with argument in short form works.
      * @throws RequiredOptionsMissingException (unexpected)
      * @throws TerminalException (unexpected)
      * @throws UnknownOptionException (unexpected)
@@ -99,7 +99,7 @@
     }
 
     /**
-     * Tests whether supplying a required option with argument in long form with separate argument works.
+     * Tests that supplying a required option with argument in long form with separate argument works.
      * @throws RequiredOptionsMissingException (unexpected)
      * @throws TerminalException (unexpected)
      * @throws UnknownOptionException (unexpected)
@@ -115,7 +115,7 @@
     }
 
     /**
-     * Tests whether supplying a required option with argument in long form with integrated argument works.
+     * Tests that supplying a required option with argument in long form with integrated argument works.
      * @throws RequiredOptionsMissingException (unexpected)
      * @throws TerminalException (unexpected)
      * @throws UnknownOptionException (unexpected)
@@ -131,7 +131,7 @@
     }
 
     /**
-     * Tests whether it's detected that a required option is missing.
+     * Tests that it's detected that a required option is missing.
      * @throws RequiredOptionsMissingException (expected)
      * @throws TerminalException (unexpected)
      * @throws UnknownOptionException (unexpected)
@@ -148,7 +148,7 @@
     }
 
     /**
-     * Tests whether it's not detected that a required option is missing if the command doesn't want it.
+     * Tests that it's not detected that a required option is missing if the command doesn't want it.
      * @throws RequiredOptionsMissingException (unexpected)
      * @throws TerminalException (unexpected)
      * @throws UnknownOptionException (unexpected)
@@ -163,7 +163,7 @@
     }
 
     /**
-     * Tests whether it's detected that an unknown option was given.
+     * Tests that it's detected that an unknown option was given.
      * @throws RequiredOptionsMissingException (unexpected)
      * @throws TerminalException (unexpected)
      * @throws UnknownOptionException (expected)
@@ -180,7 +180,7 @@
     }
 
     /**
-     * Tests whether it's detected that the argument of an option that requires an argument is missing.
+     * Tests that it's detected that the argument of an option that requires an argument is missing.
      * @throws RequiredOptionsMissingException (unexpected)
      * @throws TerminalException (unexpected)
      * @throws UnknownOptionException (unexpected)
@@ -197,7 +197,7 @@
     }
 
     /**
-     * Tests whether specifying an option twice works.
+     * Tests that specifying an option twice works.
      * @throws RequiredOptionsMissingException (unexpected)
      * @throws TerminalException (unexpected)
      * @throws UnknownOptionException (unexpected)
@@ -213,7 +213,7 @@
     }
 
     /**
-     * Tests whether help works.
+     * Tests that help works.
      * @throws RequiredOptionsMissingException (unexpected)
      * @throws TerminalException (expected)
      * @throws UnknownOptionException (unexpected)
@@ -226,7 +226,7 @@
     }
 
     /**
-     * Tests whether stopping option parsing with -- works.
+     * Tests that stopping option parsing with -- works.
      * @throws RequiredOptionsMissingException (unexpected)
      * @throws TerminalException (unexpected)
      * @throws UnknownOptionException (unexpected)
@@ -242,7 +242,7 @@
     }
 
     /**
-     * Tests whether reading options from a file works.
+     * Tests that reading options from a file works.
      * @throws RequiredOptionsMissingException (unexpected)
      * @throws TerminalException (unexpected)
      * @throws UnknownOptionException (unexpected)

Modified: libs/argparser/trunk/src/test/net/sf/japi/io/args/BasicCommandTest.java
===================================================================
--- libs/argparser/trunk/src/test/net/sf/japi/io/args/BasicCommandTest.java	2007-07-13 20:14:47 UTC (rev 532)
+++ libs/argparser/trunk/src/test/net/sf/japi/io/args/BasicCommandTest.java	2007-07-13 20:17:32 UTC (rev 533)
@@ -19,11 +19,11 @@
 
 package test.net.sf.japi.io.args;
 
+import java.util.ArrayList;
+import java.util.ResourceBundle;
 import net.sf.japi.io.args.BasicCommand;
 import org.junit.Assert;
 import org.junit.Test;
-import java.util.ArrayList;
-import java.util.ResourceBundle;
 
 /**
  * Test for {@link BasicCommand}.
@@ -33,7 +33,7 @@
 public class BasicCommandTest {
 
     /**
-     * Tests whether {@link BasicCommand#BasicCommand()} works.
+     * Tests that {@link BasicCommand#BasicCommand()} works.
      * @throws Exception (unexpected)
      */
     @Test
@@ -43,7 +43,7 @@
     }
 
     /**
-     * Tests whether {@link BasicCommand#setExiting(Boolean)} works.
+     * Tests that {@link BasicCommand#setExiting(Boolean)} works.
      * @throws Exception (unexpected)
      */
     @Test
@@ -56,7 +56,7 @@
     }
 
     /**
-     * Tests whether {@link BasicCommand#isExiting()} works.
+     * Tests that {@link BasicCommand#isExiting()} works.
      * @throws Exception (unexpected)
      */
     @Test
@@ -65,7 +65,7 @@
     }
 
     /**
-     * Tests whether {@link BasicCommand#help()} works.
+     * Tests that {@link BasicCommand#help()} works.
      * @throws Exception (unexpected)
      */
     @Test
@@ -75,7 +75,7 @@
     }
 
     /**
-     * Tests whether {@link BasicCommand#getBundle()} works.
+     * Tests that {@link BasicCommand#getBundle()} works.
      * @throws Exception (unexpected)
      */
     @Test
@@ -86,7 +86,7 @@
     }
 
     /**
-     * Tests whether {@link BasicCommand#getString(String)} returns the value from the correct bundle.
+     * Tests that {@link BasicCommand#getString(String)} returns the value from the correct bundle.
      * testGetString1 must be defined in RBMockCommand.properties with value String1FromDefaultBundle.
      * testGetString1 must be defined in RBMockCommandMyBundle.properties with value String1FromMyBundle.
      * testGetString2 must be defined in RBMockCommand.properties with value String2FromDefaultBundle.
@@ -104,7 +104,7 @@
     }
 
     /**
-     * Tests whether {@link BasicCommand#getHelpHeader()} returns the value from the correct bundle.
+     * Tests that {@link BasicCommand#getHelpHeader()} returns the value from the correct bundle.
      */
     @Test
     public void testGetHelpHeader() {

Modified: libs/argparser/trunk/src/test/net/sf/japi/io/args/MethodOptionComparatorTest.java
===================================================================
--- libs/argparser/trunk/src/test/net/sf/japi/io/args/MethodOptionComparatorTest.java	2007-07-13 20:14:47 UTC (rev 532)
+++ libs/argparser/trunk/src/test/net/sf/japi/io/args/MethodOptionComparatorTest.java	2007-07-13 20:17:32 UTC (rev 533)
@@ -35,7 +35,7 @@
  */
 public class MethodOptionComparatorTest {
 
-    /** Tests whether comparing two methods yields the expected result.
+    /** Tests that comparing two methods yields the expected result.
      * @throws NoSuchMethodException (unexpected)
      */
     @Test
@@ -53,7 +53,7 @@
         Assert.assertTrue("-f / --foo must be sorted before -Z.", comparator.compare(mFoo, mZ) < 0);
     }
 
-    /** Tests whether comparing two methods that only differ in case yields the difference.
+    /** Tests that comparing two methods that only differ in case yields the difference.
      * Test for <a href="http://sourceforge.net/tracker/index.php?func=detail&amp;aid=1748308&amp;group_id=149894&amp;atid=776737">[ 1748308 ] Options that only differ in case are not listed in --help</a>
      * @throws NoSuchMethodException (unexpected)
      */

Modified: libs/argparser/trunk/src/test/net/sf/japi/io/args/MissingArgumentExceptionTest.java
===================================================================
--- libs/argparser/trunk/src/test/net/sf/japi/io/args/MissingArgumentExceptionTest.java	2007-07-13 20:14:47 UTC (rev 532)
+++ libs/argparser/trunk/src/test/net/sf/japi/io/args/MissingArgumentExceptionTest.java	2007-07-13 20:17:32 UTC (rev 533)
@@ -31,7 +31,7 @@
 public class MissingArgumentExceptionTest {
 
     /**
-     * Tests whether {@link MissingArgumentException#MissingArgumentException(String)} works.
+     * Tests that {@link MissingArgumentException#MissingArgumentException(String)} works.
      * @throws Exception (unexpected)
      */
     @Test
@@ -41,7 +41,7 @@
     }
 
     /**
-     * Tests whether {@link MissingArgumentException#getOption()} works.
+     * Tests that {@link MissingArgumentException#getOption()} works.
      * @throws Exception (unexpected)
      */
     @Test

Modified: libs/argparser/trunk/src/test/net/sf/japi/io/args/OptionTypeTest.java
===================================================================
--- libs/argparser/trunk/src/test/net/sf/japi/io/args/OptionTypeTest.java	2007-07-13 20:14:47 UTC (rev 532)
+++ libs/argparser/trunk/src/test/net/sf/japi/io/args/OptionTypeTest.java	2007-07-13 20:17:32 UTC (rev 533)
@@ -19,10 +19,10 @@
 
 package test.net.sf.japi.io.args;
 
+import java.util.Locale;
 import net.sf.japi.io.args.OptionType;
 import org.junit.Assert;
 import org.junit.Test;
-import java.util.Locale;
 
 /**
  * Test for {@link OptionType}.
@@ -32,7 +32,7 @@
 public class OptionTypeTest {
 
     /**
-     * Tests whether {@link OptionType#getName()} and {@link OptionType#getName(Locale)} work.
+     * Tests that {@link OptionType#getName()} and {@link OptionType#getName(Locale)} work.
      * @throws Exception (unexpected)
      */
     @Test
@@ -46,7 +46,7 @@
     }
 
     /**
-     * Tests whether {@link OptionType#toString()} works.
+     * Tests that {@link OptionType#toString()} works.
      * @throws Exception (unexpected)
      */
     @Test
@@ -57,7 +57,7 @@
     }
 
     /**
-     * Tests whether {@link OptionType#getDescription()} and {@link OptionType#getDescription(Locale)} work.
+     * Tests that {@link OptionType#getDescription()} and {@link OptionType#getDescription(Locale)} work.
      * @throws Exception (unexpected)
      */
     @Test

Modified: libs/argparser/trunk/src/test/net/sf/japi/io/args/RequiredOptionsMissingExceptionTest.java
===================================================================
--- libs/argparser/trunk/src/test/net/sf/japi/io/args/RequiredOptionsMissingExceptionTest.java	2007-07-13 20:14:47 UTC (rev 532)
+++ libs/argparser/trunk/src/test/net/sf/japi/io/args/RequiredOptionsMissingExceptionTest.java	2007-07-13 20:17:32 UTC (rev 533)
@@ -19,10 +19,10 @@
 
 package test.net.sf.japi.io.args;
 
+import java.util.Arrays;
 import net.sf.japi.io.args.RequiredOptionsMissingException;
 import org.junit.Assert;
 import org.junit.Test;
-import java.util.Arrays;
 
 /**
  * Test for {@link RequiredOptionsMissingException}.
@@ -32,7 +32,7 @@
 public class RequiredOptionsMissingExceptionTest {
 
     /**
-     * Tests whether {@link RequiredOptionsMissingException#RequiredOptionsMissingException(String[])} works.
+     * Tests that {@link RequiredOptionsMissingException#RequiredOptionsMissingException(String[])} works.
      * @throws Exception (unexpected)
      */
     @Test
@@ -43,7 +43,7 @@
     }
 
     /**
-     * Tests whether {@link RequiredOptionsMissingException#getMissingOptions()} works.
+     * Tests that {@link RequiredOptionsMissingException#getMissingOptions()} works.
      * @throws Exception (unexpected)
      */
     @Test

Modified: libs/argparser/trunk/src/test/net/sf/japi/io/args/StringJoinerTest.java
===================================================================
--- libs/argparser/trunk/src/test/net/sf/japi/io/args/StringJoinerTest.java	2007-07-13 20:14:47 UTC (rev 532)
+++ libs/argparser/trunk/src/test/net/sf/japi/io/args/StringJoinerTest.java	2007-07-13 20:17:32 UTC (rev 533)
@@ -43,7 +43,7 @@
     private static final String[] ARGS = {"foo", "bar", "buzz"};
 
     /**
-     * Tests whether {@link StringJoiner#join(CharSequence,CharSequence...)} works.
+     * Tests that {@link StringJoiner#join(CharSequence,CharSequence...)} works.
      */
     @Test
     public void testJoinCSCS() {
@@ -54,7 +54,7 @@
     }
 
     /**
-     * Tests whether {@link StringJoiner#join(CharSequence,Iterable<? extends java.lang.CharSequence>)} works.
+     * Tests that {@link StringJoiner#join(CharSequence,Iterable<? extends java.lang.CharSequence>)} works.
      */
     @Test
     public void testJoinCSIe() {
@@ -65,7 +65,7 @@
     }
 
     /**
-     * Tests whether {@link StringJoiner#join(CharSequence,java.util.Iterator<? extends java.lang.CharSequence>)} works.
+     * Tests that {@link StringJoiner#join(CharSequence,java.util.Iterator<? extends java.lang.CharSequence>)} works.
      */
     @Test
     public void testJoinCSIr() {

Modified: libs/argparser/trunk/src/test/net/sf/japi/io/args/TerminalExceptionTest.java
===================================================================
--- libs/argparser/trunk/src/test/net/sf/japi/io/args/TerminalExceptionTest.java	2007-07-13 20:14:47 UTC (rev 532)
+++ libs/argparser/trunk/src/test/net/sf/japi/io/args/TerminalExceptionTest.java	2007-07-13 20:17:32 UTC (rev 533)
@@ -31,7 +31,7 @@
 public class TerminalExceptionTest {
 
     /**
-     * Tests whether {@link TerminalException#TerminalException()} works.
+     * Tests that {@link TerminalException#TerminalException()} works.
      * @throws Exception (unexpected)
      */
     @Test
@@ -41,7 +41,7 @@
     }
 
     /**
-     * Tests whether {@link TerminalException#getReturnCode()} works.
+     * Tests that {@link TerminalException#getReturnCode()} works.
      * @throws Exception (unexpected)
      */
     @Test

Modified: libs/argparser/trunk/src/test/net/sf/japi/io/args/UnknownOptionExceptionTest.java
===================================================================
--- libs/argparser/trunk/src/test/net/sf/japi/io/args/UnknownOptionExceptionTest.java	2007-07-13 20:14:47 UTC (rev 532)
+++ libs/argparser/trunk/src/test/net/sf/japi/io/args/UnknownOptionExceptionTest.java	2007-07-13 20:17:32 UTC (rev 533)
@@ -19,10 +19,10 @@
 
 package test.net.sf.japi.io.args;
 
+import java.util.Arrays;
 import net.sf.japi.io.args.UnknownOptionException;
 import org.junit.Assert;
 import org.junit.Test;
-import java.util.Arrays;
 
 /**
  * Test for {@link UnknownOptionException}.
@@ -32,7 +32,7 @@
 public class UnknownOptionExceptionTest {
 
     /**
-     * Tests whether {@link UnknownOptionException#UnknownOptionException(String[])} works.
+     * Tests that {@link UnknownOptionException#UnknownOptionException(String[])} works.
      * @throws Exception (unexpected)
      */
     @Test
@@ -43,7 +43,7 @@
     }
 
     /**
-     * Tests whether {@link UnknownOptionException#getUnknownOptions()} works.
+     * Tests that {@link UnknownOptionException#getUnknownOptions()} works.
      * @throws Exception (unexpected)
      */
     @Test


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