[Japi-cvs] SF.net SVN: japi: [245] libs/argparser/trunk/src

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

Revision: 245
          http://svn.sourceforge.net/japi/?rev=245&view=rev
Author:   christianhujer
Date:     2006-12-02 15:27:43 -0800 (Sat, 02 Dec 2006)

Log Message:
-----------
Fixed Javadoc issues.

Modified Paths:
--------------
    libs/argparser/trunk/src/doc/examples/Head.java
    libs/argparser/trunk/src/net/sf/japi/io/args/BasicCommand.java
    libs/argparser/trunk/src/net/sf/japi/io/args/StringJoiner.java
    libs/argparser/trunk/src/test/net/sf/japi/io/args/converter/AbstractConverterTest.java
    libs/argparser/trunk/src/test/net/sf/japi/io/args/converter/ConverterRegistryTest.java
    libs/argparser/trunk/src/test/net/sf/japi/io/args/converter/NoConverterFoundExceptionTest.java

Modified: libs/argparser/trunk/src/doc/examples/Head.java
===================================================================
--- libs/argparser/trunk/src/doc/examples/Head.java	2006-12-02 22:52:52 UTC (rev 244)
+++ libs/argparser/trunk/src/doc/examples/Head.java	2006-12-02 23:27:43 UTC (rev 245)
@@ -109,6 +109,7 @@
     /**
      * Copies the configured number of items from the specified InputStream to System.out.
      * @param in InputStream to run on
+     * @throws IOException In case of I/O problems.
      */
     private void copyItems(final InputStream in) throws IOException {
         if (printBytes) {

Modified: libs/argparser/trunk/src/net/sf/japi/io/args/BasicCommand.java
===================================================================
--- libs/argparser/trunk/src/net/sf/japi/io/args/BasicCommand.java	2006-12-02 22:52:52 UTC (rev 244)
+++ libs/argparser/trunk/src/net/sf/japi/io/args/BasicCommand.java	2006-12-02 23:27:43 UTC (rev 245)
@@ -22,7 +22,10 @@
     /** The maximum width of the option type field. */
     private final int maxOptionTypeWidth;
 
-    /** @see Command#isExiting() */
+    /**
+     * Whether to exit or not.
+     *  @see Command#isExiting()
+     */
     private boolean exiting;
 
     /** Create a BasicCommand. */
@@ -34,7 +37,10 @@
         maxOptionTypeWidth = tmpMaxOptionTypeWidth;
     }
 
-    /** Exit Option. */
+    /**
+     * Exit Option.
+     * @param exiting <code>true</code> if {@link System#exit(int)} should be invoked, otherwise <code>false</code>.
+     */
     @Option(value = {"exit"})
     public void setExiting(@NotNull final Boolean exiting) {
         this.exiting = exiting;

Modified: libs/argparser/trunk/src/net/sf/japi/io/args/StringJoiner.java
===================================================================
--- libs/argparser/trunk/src/net/sf/japi/io/args/StringJoiner.java	2006-12-02 22:52:52 UTC (rev 244)
+++ libs/argparser/trunk/src/net/sf/japi/io/args/StringJoiner.java	2006-12-02 23:27:43 UTC (rev 245)
@@ -57,6 +57,7 @@
      * @param delim delimiter to use for joining the strings
      * @param strings Strings to join
      * @return Appendable
+     * @throws IOException In case of I/O problems on <var>dest</var>.
      */
     public static Appendable join(final Appendable dest, final CharSequence delim, final CharSequence... strings) throws IOException {
         for (int i = 0; i < strings.length; i++) {
@@ -74,6 +75,7 @@
      * @param delim delimiter to use for joining the strings
      * @param strings Strings to join
      * @return Appendable
+     * @throws IOException In case of I/O problems on <var>dest</var>.
      */
     public static Appendable join(final Appendable dest, final CharSequence delim, final Iterable<? extends CharSequence> strings) throws IOException {
         return join(dest, delim, strings.iterator());
@@ -85,6 +87,7 @@
      * @param delim delimiter to use for joining the strings
      * @param strings Strings to join
      * @return Appendable
+     * @throws IOException In case of I/O problems on <var>dest</var>.
      */
     public static Appendable join(final Appendable dest, final CharSequence delim, final Iterator<? extends CharSequence> strings) throws IOException {
         if (strings.hasNext()) {

Modified: libs/argparser/trunk/src/test/net/sf/japi/io/args/converter/AbstractConverterTest.java
===================================================================
--- libs/argparser/trunk/src/test/net/sf/japi/io/args/converter/AbstractConverterTest.java	2006-12-02 22:52:52 UTC (rev 244)
+++ libs/argparser/trunk/src/test/net/sf/japi/io/args/converter/AbstractConverterTest.java	2006-12-02 23:27:43 UTC (rev 245)
@@ -39,7 +39,7 @@
     }
 
     /**
-     * Tests whether convert throws a NullPointerException if invoked with <code>null</code>
+     * Tests whether convert throws a NullPointerException if invoked with <code>null</code>.
      * @throws Exception In case of test problems.
      */
     @SuppressWarnings({"ConstantConditions"})

Modified: libs/argparser/trunk/src/test/net/sf/japi/io/args/converter/ConverterRegistryTest.java
===================================================================
--- libs/argparser/trunk/src/test/net/sf/japi/io/args/converter/ConverterRegistryTest.java	2006-12-02 22:52:52 UTC (rev 244)
+++ libs/argparser/trunk/src/test/net/sf/japi/io/args/converter/ConverterRegistryTest.java	2006-12-02 23:27:43 UTC (rev 245)
@@ -12,7 +12,6 @@
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
  */
 public class ConverterRegistryTest {
-    ConverterRegistry converterRegistry;
 
     /**
      * Tests that creating a new ConverterRegistry works.
@@ -20,6 +19,7 @@
      */
     @Test
     public void testConverterRegistry() throws Exception {
+        //noinspection UnusedDeclaration
         final ConverterRegistry converterRegistry = new ConverterRegistry();
     }
 

Modified: libs/argparser/trunk/src/test/net/sf/japi/io/args/converter/NoConverterFoundExceptionTest.java
===================================================================
--- libs/argparser/trunk/src/test/net/sf/japi/io/args/converter/NoConverterFoundExceptionTest.java	2006-12-02 22:52:52 UTC (rev 244)
+++ libs/argparser/trunk/src/test/net/sf/japi/io/args/converter/NoConverterFoundExceptionTest.java	2006-12-02 23:27:43 UTC (rev 245)
@@ -6,6 +6,7 @@
 
 /**
  * Test for {@link NoConverterFoundException}.
+ * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
  */
 public class NoConverterFoundExceptionTest {
 


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