[jsword-svn] r1910 - in trunk/common/src/main/java/org/crosswire/common: diff icu util xml

[dmsmith at www.crosswire.org]

Author: dmsmith
Date: 2008-07-25 12:00:43 -0700 (Fri, 25 Jul 2008)
New Revision: 1910

Modified:
   trunk/common/src/main/java/org/crosswire/common/diff/PatchEntry.java
   trunk/common/src/main/java/org/crosswire/common/icu/DateFormatter.java
   trunk/common/src/main/java/org/crosswire/common/icu/NumberShaper.java
   trunk/common/src/main/java/org/crosswire/common/util/Translations.java
   trunk/common/src/main/java/org/crosswire/common/xml/XMLUtil.java
Log:
QA changes: checkstyle, javadoc

Modified: trunk/common/src/main/java/org/crosswire/common/diff/PatchEntry.java
===================================================================
--- trunk/common/src/main/java/org/crosswire/common/diff/PatchEntry.java	2008-07-25 19:00:36 UTC (rev 1909)
+++ trunk/common/src/main/java/org/crosswire/common/diff/PatchEntry.java	2008-07-25 19:00:43 UTC (rev 1910)
@@ -418,8 +418,8 @@
      * This algorithm allows for \n to be included in a difference.
      * Thus it needs to be escaped. We will use URL encoding of \n.
      * But this makes % a meta-character, thus it needs to be encoded too.
-     * @param str
-     * @return
+     * @param str the un-encoded string
+     * @return the encoded string
      */
     private String encode(String str)
     {

Modified: trunk/common/src/main/java/org/crosswire/common/icu/DateFormatter.java
===================================================================
--- trunk/common/src/main/java/org/crosswire/common/icu/DateFormatter.java	2008-07-25 19:00:36 UTC (rev 1909)
+++ trunk/common/src/main/java/org/crosswire/common/icu/DateFormatter.java	2008-07-25 19:00:43 UTC (rev 1910)
@@ -86,7 +86,7 @@
             fmt.formatterClass = DateFormat.class;
             fmt.formatter = DateFormat.getDateInstance(format);
         }
- 
+
         return fmt;
     }
 

Modified: trunk/common/src/main/java/org/crosswire/common/icu/NumberShaper.java
===================================================================
--- trunk/common/src/main/java/org/crosswire/common/icu/NumberShaper.java	2008-07-25 19:00:36 UTC (rev 1909)
+++ trunk/common/src/main/java/org/crosswire/common/icu/NumberShaper.java	2008-07-25 19:00:43 UTC (rev 1910)
@@ -62,7 +62,7 @@
     /**
      * Create a shaper that is appropriate for the given locale.
      * 
-     * @param the requested Locale
+     * @param locale the requested Locale
      */
     public NumberShaper(Locale locale)
     {
@@ -154,7 +154,7 @@
     /**
      * @param src
      * @param transformed
-     * @return
+     * @return the shaped string
      */
     private char[] shaped(char[] src, boolean[] transformed)
     {
@@ -175,7 +175,7 @@
      * @param nine nine in the source representation
      * @param offset the distance between zeros in the source and target representation
      * @param transformed an input parameter of one boolean that can hold whether there was a transformation
-     * @return
+     * @return the shaped string
      */
     private char[] transform(char[] src, int zero, int nine, int offset, boolean[] transformed)
     {
@@ -303,7 +303,7 @@
     /**
      * Establish nine for the language. There are languages that don't have zeroes.
      * 
-     * @return
+     * @return the representation for 9 in the language
      */
     private char getNine()
     {

Modified: trunk/common/src/main/java/org/crosswire/common/util/Translations.java
===================================================================
--- trunk/common/src/main/java/org/crosswire/common/util/Translations.java	2008-07-25 19:00:36 UTC (rev 1909)
+++ trunk/common/src/main/java/org/crosswire/common/util/Translations.java	2008-07-25 19:00:43 UTC (rev 1910)
@@ -152,7 +152,7 @@
     /**
      * Set the current translation, using human readable string.
      * 
-     * @param translation the translation to use
+     * @param newTranslation the translation to use
      */
     public void setCurrent(String newTranslation)
     {
@@ -221,7 +221,7 @@
     /**
      * Set the current translation, using human readable string.
      * 
-     * @param translation the translation to use
+     * @param newTranslation the translation to use
      */
     public static void setCurrentTranslation(String newTranslation)
     {

Modified: trunk/common/src/main/java/org/crosswire/common/xml/XMLUtil.java
===================================================================
--- trunk/common/src/main/java/org/crosswire/common/xml/XMLUtil.java	2008-07-25 19:00:36 UTC (rev 1909)
+++ trunk/common/src/main/java/org/crosswire/common/xml/XMLUtil.java	2008-07-25 19:00:43 UTC (rev 1910)
@@ -90,7 +90,7 @@
      * Get the full name of the attribute, including the namespace if any.
      * @param attrs the collection of attributes
      * @param index the index of the desired attribute
-     * @return
+     * @return the requested attribute
      */
     public static String getAttributeName(Attributes attrs, int index)
     {