ICU-6237 Fixed Javadoc warnings for "collate" "charset" and "translit" packages.

X-SVN-Rev: 26502

icu4j/main/classes/collate/src/com/ibm/icu/text/CollationParsedRuleBuilder.java

@@ -717,8 +717,7 @@ final class CollationParsedRuleBuilder {
         /**
          * Compares this object with target
          * 
-         * @param target
-         *            object to compare with
+         * @param target object to compare with
          * @return 0 if equals, 1 if this is > target, -1 otherwise
          */
         public int compareTo(WeightRange target) {
@@ -982,8 +981,8 @@ final class CollationParsedRuleBuilder {
         /**
          * For construction of the Trie tables. Has to be labeled public
          * 
-         * @param cp
-         * @param offset
+         * @param cp The value of the code point.
+         * @param offset The value of the offset.
          * @return data offset or 0
          */
         public int getFoldedValue(int cp, int offset) {
@@ -1183,8 +1182,7 @@ final class CollationParsedRuleBuilder {
         /**
          * Equals calculation
          * 
-         * @param target
-         *            object to compare
+         * @param target Object to compare
          * @return true if target is the same as this object
          */
         public boolean equals(Object target) {

icu4j/main/classes/collate/src/com/ibm/icu/text/IndexCharacters.java

@@ -79,7 +79,7 @@ public class IndexCharacters {
 
     /**
      * Create the index object.
-     * @param locale
+     * @param locale The locale to be passed.
      * @draft ICU 4.2
      * @provisional This API might change or be removed in a future release.
      */

icu4j/main/classes/collate/src/com/ibm/icu/text/RuleBasedCollator.java

@@ -720,8 +720,6 @@ public final class RuleBasedCollator extends Collator
      * @return a pointer to a UnicodeSet object containing all the
      *         code points and sequences that may sort differently than
      *         in the UCA.
-     * @exception ParseException thrown when argument rules have an
-     *            invalid syntax. IOException
      * @stable ICU 2.4
      */
     public UnicodeSet getTailoredSet()
@@ -857,7 +855,7 @@ public final class RuleBasedCollator extends Collator
      * @param contractions if not null, set to contain contractions
      * @param expansions if not null, set to contain expansions
      * @param addPrefixes add the prefix contextual elements to contractions
-     * @throws Exception 
+     * @throws Exception Throws an exception if any errors occurs.
      * @stable ICU 3.4
      */
     public void

icu4j/main/classes/collate/src/com/ibm/icu/util/GlobalizationPreferences.java

@@ -489,7 +489,7 @@ public class GlobalizationPreferences implements Freezable {
 
     /**
      * Explicitly set the collator for this object.
-     * @param collator
+     * @param collator The collator object to be passed.
      * @return this, for chaining
      * @draft ICU 3.6
      * @provisional This API might change or be removed in a future release.
@@ -510,8 +510,7 @@ public class GlobalizationPreferences implements Freezable {
      * Get a copy of the break iterator for the specified type according to the
      * settings.
      * 
-     * @param type
-     *          break type - BI_CHARACTER or BI_WORD, BI_LINE, BI_SENTENCE, BI_TITLE
+     * @param type break type - BI_CHARACTER or BI_WORD, BI_LINE, BI_SENTENCE, BI_TITLE
      * @return break iterator explicit or implicit
      * @draft ICU 3.6
      * @provisional This API might change or be removed in a future release.
@@ -529,8 +528,7 @@ public class GlobalizationPreferences implements Freezable {
     /**
      * Explicitly set the break iterator for this object.
      * 
-     * @param type
-     *          break type - BI_CHARACTER or BI_WORD, BI_LINE, BI_SENTENCE, BI_TITLE
+     * @param type break type - BI_CHARACTER or BI_WORD, BI_LINE, BI_SENTENCE, BI_TITLE
      * @param iterator a break iterator
      * @return this, for chaining
      * @draft ICU 3.6

icu4j/main/classes/translit/src/com/ibm/icu/text/AnyTransliterator.java

@@ -142,12 +142,13 @@ class AnyTransliterator extends Transliterator {
     }
 
     /**
-     * @param id
-     * @param filter
-     * @param target2
-     * @param targetScript2
-     * @param widthFix2
-     * @param cache2
+     * @param id the ID of the form S-T or S-T/V, where T is theTarget
+     * and V is theVariant.  Must not be empty.
+     * @param filter The Unicode filter.
+     * @param target2 the target name. 
+     * @param targetScript2 the script code corresponding to theTarget.
+     * @param widthFix2 The Transliterator width fix.
+     * @param cache2 The Map object for cache.
      */
     public AnyTransliterator(String id, UnicodeFilter filter, String target2,
             int targetScript2, Transliterator widthFix2, Map<Integer, Transliterator> cache2) {
@@ -394,7 +395,7 @@ class AnyTransliterator extends Transliterator {
     /**
      * Temporary hack for registry problem. Needs to be replaced by better architecture.
      * @internal
-     * @deprecated
+     * @deprecated Function is deprecated.
      */
     public Transliterator safeClone() {
         UnicodeFilter filter = getFilter();

icu4j/main/classes/translit/src/com/ibm/icu/text/CompoundTransliterator.java

@@ -539,7 +539,7 @@ class CompoundTransliterator extends Transliterator {
     /**
      * Temporary hack for registry problem. Needs to be replaced by better architecture.
      * @internal
-     * @deprecated
+     * @deprecated Deprecated function.
      */
     public Transliterator safeClone() {
         UnicodeFilter filter = getFilter();

icu4j/main/classes/translit/src/com/ibm/icu/text/RuleBasedTransliterator.java

@@ -469,7 +469,7 @@ public class RuleBasedTransliterator extends Transliterator {
     /**
      * Temporary hack for registry problem. Needs to be replaced by better architecture.
      * @internal
-     * @deprecated
+     * @deprecated Deprecated function.
      */
     public Transliterator safeClone() {
         UnicodeFilter filter = getFilter();

icu4j/main/classes/translit/src/com/ibm/icu/text/Transliterator.java

@@ -1886,7 +1886,7 @@ public abstract class Transliterator implements StringTransform  {
     /**
      * Register the script-based "Any" transliterators: Any-Latin, Any-Greek
      * @internal
-     * @deprecated
+     * @deprecated Deprecated function.
      */
     public static void registerAny() {
         AnyTransliterator.register();