[FOray-commit] SF.net SVN: foray: [8123] trunk/foray

[<vic...@us...>]

Revision: 8123
          http://svn.sourceforge.net/foray/?rev=8123&view=rev
Author:   victormote
Date:     2006-09-15 13:23:37 -0700 (Fri, 15 Sep 2006)

Log Message:
-----------
Add some javadoc.

Modified Paths:
--------------
    trunk/foray/foray-common/src/java/org/foray/common/Configuration.java
    trunk/foray/foray-common/src/java/org/foray/common/MUserAgent.java
    trunk/foray/foray-common/src/java/org/foray/common/RandomReader.java
    trunk/foray/foray-common/src/java/org/foray/common/XMLCharacter.java
    trunk/foray/foray-common/src/java/org/foray/common/XMLParser.java
    trunk/foray/foray-common/src/java/org/foray/common/url/URLFactory.java
    trunk/foray/scripts/checkstyle-suppressions.xml

Modified: trunk/foray/foray-common/src/java/org/foray/common/Configuration.java
===================================================================
--- trunk/foray/foray-common/src/java/org/foray/common/Configuration.java	2006-09-15 19:57:53 UTC (rev 8122)
+++ trunk/foray/foray-common/src/java/org/foray/common/Configuration.java	2006-09-15 20:23:37 UTC (rev 8123)
@@ -93,8 +93,7 @@
     protected abstract String getName();
 
     /**
-     * general access method
-     *
+     * Accessor method for a generic property.
      * @param key a string containing the key value for the configuration value
      * @return Object containing the value; normally you would use one of the
      * convenience methods, which return the correct form,
@@ -105,7 +104,7 @@
     }
 
     /**
-     * convenience methods to access strings values in the configuration
+     * Convenience method to access strings values in the configuration.
      * @param key a string containing the key value for the configuration value
      * @return String a string containing the value,
      * null   if the key is not defined.
@@ -119,10 +118,9 @@
     }
 
     /**
-     * convenience methods to access int values in the configuration
+     * Convenience methods to access int values in the configuration.
      * @param key a string containing the key value for the configuration value
-     * @return int a int containing the value,
-     * -1   if the key is not defined.
+     * @return The int value, or -1 if the key is not defined.
      */
     protected int getIntValue(final String key) {
         final Object obj = getValue(key);
@@ -133,10 +131,9 @@
     }
 
     /**
-     * convenience methods to access boolean values in the configuration
+     * Convenience method to access boolean values in the configuration.
      * @param key a string containing the key value for the configuration value
-     * @return Boolean true or false as value,
-     * null   if the key is not defined.
+     * @return The Boolean value, or null if the key is not defined.
      */
     protected Boolean getBooleanValue(final String key) {
         final Object obj = getValue(key);
@@ -150,10 +147,9 @@
     }
 
     /**
-     * convenience methods to access list values in the configuration
+     * Convenience method to access list values in the configuration.
      * @param key a string containing the key value for the configuration value
-     * @return List a List containing the values,
-     * null   if the key is not defined.
+     * @return The List value, or null if the key is not defined.
      */
     protected List getListValue(final String key) {
         final Object obj = getValue(key);

Modified: trunk/foray/foray-common/src/java/org/foray/common/MUserAgent.java
===================================================================
--- trunk/foray/foray-common/src/java/org/foray/common/MUserAgent.java	2006-09-15 19:57:53 UTC (rev 8122)
+++ trunk/foray/foray-common/src/java/org/foray/common/MUserAgent.java	2006-09-15 20:23:37 UTC (rev 8123)
@@ -40,7 +40,7 @@
 import java.awt.geom.Dimension2D;
 
 /**
- *
+ * An SVGUserAgent extension.
  */
 public class MUserAgent extends SVGUserAgent {
 

Modified: trunk/foray/foray-common/src/java/org/foray/common/RandomReader.java
===================================================================
--- trunk/foray/foray-common/src/java/org/foray/common/RandomReader.java	2006-09-15 19:57:53 UTC (rev 8122)
+++ trunk/foray/foray-common/src/java/org/foray/common/RandomReader.java	2006-09-15 20:23:37 UTC (rev 8123)
@@ -57,8 +57,9 @@
     public static final String CHAR_ENCODE_UTF_16 = "UTF-16";
 
     /**
-     * The list of supported Java character encodings can be found at
-     * java.sun.com/j2se/1.3/docs/api/java/lang/package-summary.html#charenc
+     * The list of supported Java character encodings.
+     * @see
+     * "java.sun.com/j2se/1.3/docs/api/java/lang/package-summary.html#charenc"
      */
     public static final String[] SUPPORTED_CHAR_ENCODINGS = new String[] {
         CHAR_ENCODE_US_ASCII,
@@ -550,7 +551,7 @@
         private long offsetToContent = - 1;
 
         /**
-         * Constructor
+         * Constructor.
          */
         ByteSearcher(final byte[] bytesToFind, final long startRange,
                 final long endRange, final boolean readBackward) {

Modified: trunk/foray/foray-common/src/java/org/foray/common/XMLCharacter.java
===================================================================
--- trunk/foray/foray-common/src/java/org/foray/common/XMLCharacter.java	2006-09-15 19:57:53 UTC (rev 8122)
+++ trunk/foray/foray-common/src/java/org/foray/common/XMLCharacter.java	2006-09-15 20:23:37 UTC (rev 8123)
@@ -543,9 +543,10 @@
     }
 
     /**
+     * Indicates whether the input is one of the fiver predefined XML entity
+     * references.
      * @param c The char to be tested.
-     * @return True iff <code>c</code> is one of the five predefined entity
-     * references in XML.
+     * @return True iff <code>c</code> is a predefined XML entity reference.
      */
     public static boolean isEntityReference(final char c) {
         switch (c) {
@@ -561,6 +562,8 @@
     }
 
     /**
+     * Takes an entity reference character and converts it to its expanded
+     * value. For example, "&" is converted to "&amp;".
      * @param c The char which should be converted to a predefined XML entity
      * reference.
      * @return A string containing the predefined XML entity reference for

Modified: trunk/foray/foray-common/src/java/org/foray/common/XMLParser.java
===================================================================
--- trunk/foray/foray-common/src/java/org/foray/common/XMLParser.java	2006-09-15 19:57:53 UTC (rev 8122)
+++ trunk/foray/foray-common/src/java/org/foray/common/XMLParser.java	2006-09-15 20:23:37 UTC (rev 8123)
@@ -34,7 +34,7 @@
 import javax.xml.parsers.SAXParserFactory;
 
 /**
- *
+ * Utility class that provides information about an XML Parser.
  */
 public final class XMLParser {
 

Modified: trunk/foray/foray-common/src/java/org/foray/common/url/URLFactory.java
===================================================================
--- trunk/foray/foray-common/src/java/org/foray/common/url/URLFactory.java	2006-09-15 19:57:53 UTC (rev 8122)
+++ trunk/foray/foray-common/src/java/org/foray/common/url/URLFactory.java	2006-09-15 20:23:37 UTC (rev 8123)
@@ -57,6 +57,7 @@
     private URLFactory() { }
 
     /**
+     * Creates a URL instance.
      * @see URL#URL(java.lang.String) which this method mimics.
      */
     public static URL createURL(final String spec)
@@ -66,6 +67,7 @@
     }
 
     /**
+     * Creates a URL instance.
      * @see URL#URL(java.lang.String, java.lang.String, int, java.lang.String)
      * which this method mimics.
      */
@@ -76,6 +78,7 @@
     }
 
     /**
+     * Creates a URL instance.
      * @see URL#URL(java.lang.String, java.lang.String, int, java.lang.String,
      * java.net.URLStreamHandler) which this method mimics.
      */
@@ -91,6 +94,7 @@
     }
 
     /**
+     * Creates a URL instance.
      * @see URL#URL(java.lang.String, java.lang.String, java.lang.String)
      * which this method mimics.
      */
@@ -101,6 +105,7 @@
     }
 
     /**
+     * Creates a URL instance.
      * @see URL#URL(java.net.URL, java.lang.String) which this method mimics.
      */
     public static URL createURL(final URL context, final String spec)
@@ -110,6 +115,7 @@
     }
 
     /**
+     * Creates a URL instance.
      * @see URL#URL(java.net.URL, java.lang.String, java.net.URLStreamHandler)
      * which this method mimics.
      */

Modified: trunk/foray/scripts/checkstyle-suppressions.xml
===================================================================
--- trunk/foray/scripts/checkstyle-suppressions.xml	2006-09-15 19:57:53 UTC (rev 8122)
+++ trunk/foray/scripts/checkstyle-suppressions.xml	2006-09-15 20:23:37 UTC (rev 8123)
@@ -26,7 +26,7 @@
       files="org.foray.demo.*"/>
   <suppress checks="Javadoc[MVS].*"
       files="org.foray.area.*"/>
-  <suppress checks="Javadoc[MVS].*"
+  <suppress checks="Javadoc[MV].*"
       files="org.foray.common.*"/>
   <suppress checks="Javadoc[MVS].*"
       files="org.foray.core.*"/>


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