From b631035a54f2a0b1c77fdc63ccb83f54411e4b20 Mon Sep 17 00:00:00 2001 From: Doug Felt Date: Mon, 1 Dec 2003 23:39:13 +0000 Subject: [PATCH] ICU-3027 clean up @see tags in docs X-SVN-Rev: 13923 --- icu4j/src/com/ibm/icu/lang/UCharacter.java | 10 +++++----- icu4j/src/com/ibm/icu/math/BigDecimal.java | 6 +++--- icu4j/src/com/ibm/icu/text/ArabicShaping.java | 4 ++-- icu4j/src/com/ibm/icu/text/BreakIterator.java | 8 ++++---- icu4j/src/com/ibm/icu/text/CanonicalIterator.java | 9 +++++---- icu4j/src/com/ibm/icu/text/CollationKey.java | 8 ++++---- icu4j/src/com/ibm/icu/text/Collator.java | 6 +++--- icu4j/src/com/ibm/icu/text/DateFormat.java | 2 +- .../com/ibm/icu/text/DictionaryBasedBreakIterator.java | 6 +++--- icu4j/src/com/ibm/icu/text/UFormat.java | 7 +++---- 10 files changed, 33 insertions(+), 33 deletions(-) diff --git a/icu4j/src/com/ibm/icu/lang/UCharacter.java b/icu4j/src/com/ibm/icu/lang/UCharacter.java index 2c9eb9057ba..a7d0bbbc3ab 100755 --- a/icu4j/src/com/ibm/icu/lang/UCharacter.java +++ b/icu4j/src/com/ibm/icu/lang/UCharacter.java @@ -5,8 +5,8 @@ ******************************************************************************* * * $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/lang/UCharacter.java,v $ -* $Date: 2003/11/24 22:23:39 $ -* $Revision: 1.83 $ +* $Date: 2003/12/01 23:39:13 $ +* $Revision: 1.84 $ * ******************************************************************************* */ @@ -1956,7 +1956,7 @@ public final class UCharacter /** * Hangul Syllable Type constants. * - * @see HANGUL_SYLLABLE_TYPE + * @see UProperty#HANGUL_SYLLABLE_TYPE * @draft ICU 2.6 */ public static interface HangulSyllableType @@ -2905,7 +2905,7 @@ public final class UCharacter *
  • Not-a-character, having the form 0x xxFFFF or 0x xxFFFE * * Note: legal does not mean that it is assigned in this version of Unicode. - * @param ch code point to determine if it is a legal code point by itself + * @param str containing code points to examin * @return true if and only if legal. * @stable ICU 2.1 */ @@ -4062,7 +4062,7 @@ public final class UCharacter *

    Important: If ICU is built with UCD files from Unicode versions * below 3.2, then properties marked with "new" are not or * not fully available.

    - * @param codepoint Code point to test. + * @param ch code point to test. * @param property selector constant from com.ibm.icu.lang.UProperty, * identifies which binary property to check. * @return true or false according to the binary Unicode property value diff --git a/icu4j/src/com/ibm/icu/math/BigDecimal.java b/icu4j/src/com/ibm/icu/math/BigDecimal.java index d7f80546d72..b68475fe01b 100755 --- a/icu4j/src/com/ibm/icu/math/BigDecimal.java +++ b/icu4j/src/com/ibm/icu/math/BigDecimal.java @@ -2197,7 +2197,7 @@ public class BigDecimal extends java.lang.Number implements java.io.Serializable * The {@link #compareTo(BigDecimal, MathContext)} method should be * used when a MathContext is needed for the comparison. * - * @param rhs The Object for the right hand side of + * @param rhsobj The Object for the right hand side of * the comparison. * @return An int whose value is -1, 0, or 1 as * this is numerically less than, equal to, @@ -2250,7 +2250,7 @@ public class BigDecimal extends java.lang.Number implements java.io.Serializable *

    * The {@link #compareTo(BigDecimal, MathContext)} method should be * used for more general comparisons. - * @param rhs The Object for the right hand side of + * @param obj The Object for the right hand side of * the comparison. * @return A boolean whose value true if and * only if the operands have identical string representations. @@ -2479,7 +2479,7 @@ public class BigDecimal extends java.lang.Number implements java.io.Serializable * Use 0 to force exponential notation. * Use -1 to force plain notation (no exponential * notation). - * @param exform The int specifying the form of + * @param exformint The int specifying the form of * exponential notation to be used * ({@link MathContext#SCIENTIFIC} or * {@link MathContext#ENGINEERING}). diff --git a/icu4j/src/com/ibm/icu/text/ArabicShaping.java b/icu4j/src/com/ibm/icu/text/ArabicShaping.java index 1ad1e728ea7..80c1eac0546 100755 --- a/icu4j/src/com/ibm/icu/text/ArabicShaping.java +++ b/icu4j/src/com/ibm/icu/text/ArabicShaping.java @@ -123,8 +123,8 @@ public final class ArabicShaping { /** * Convert a string, returning the new string. * - * @param source The string to convert. - * @return The converted string. + * @param text the string to convert + * @return the converted string * @throws ArabicShapingException if the string cannot be converted according to the options. * @stable ICU 2.0 */ diff --git a/icu4j/src/com/ibm/icu/text/BreakIterator.java b/icu4j/src/com/ibm/icu/text/BreakIterator.java index c29ec0146b1..51db3037c42 100755 --- a/icu4j/src/com/ibm/icu/text/BreakIterator.java +++ b/icu4j/src/com/ibm/icu/text/BreakIterator.java @@ -5,8 +5,8 @@ ******************************************************************************* * * $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/text/BreakIterator.java,v $ - * $Date: 2003/11/14 23:45:01 $ - * $Revision: 1.24 $ + * $Date: 2003/12/01 23:39:13 $ + * $Revision: 1.25 $ * ***************************************************************************************** */ @@ -538,7 +538,7 @@ public abstract class BreakIterator implements Cloneable * This function assumes the text being analyzed is in the default locale's * language. The iterator returned locates title boundaries as described for * Unicode 3.2 only. For Unicode 4.0 and above title boundary iteration, - * please use Word Boundary iterator.{@link getWordInstance} + * please use a word boundary iterator. {@link #getWordInstance} * @return A new instance of BreakIterator that locates title boundaries. * @stable ICU 2.0 */ @@ -551,7 +551,7 @@ public abstract class BreakIterator implements Cloneable * Returns a new instance of BreakIterator that locates title boundaries. * The iterator returned locates title boundaries as described for * Unicode 3.2 only. For Unicode 4.0 and above title boundary iteration, - * please use Word Boundary iterator.{@link getWordInstance} + * please use Word Boundary iterator.{@link #getWordInstance} * @param where A Locale specifying the language of the text being analyzed. * @return A new instance of BreakIterator that locates title boundaries. * @stable ICU 2.0 diff --git a/icu4j/src/com/ibm/icu/text/CanonicalIterator.java b/icu4j/src/com/ibm/icu/text/CanonicalIterator.java index e616de240f4..16818ed60d0 100755 --- a/icu4j/src/com/ibm/icu/text/CanonicalIterator.java +++ b/icu4j/src/com/ibm/icu/text/CanonicalIterator.java @@ -5,8 +5,8 @@ ******************************************************************************* * * $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/text/CanonicalIterator.java,v $ - * $Date: 2003/06/09 23:31:10 $ - * $Revision: 1.16 $ + * $Date: 2003/12/01 23:39:13 $ + * $Revision: 1.17 $ * ***************************************************************************************** */ @@ -106,7 +106,7 @@ public final class CanonicalIterator { /** * Set a new source for this iterator. Allows object reuse. - * @param set the source string to iterate against. This allows the same iterator to be used + * @param newSource the source string to iterate against. This allows the same iterator to be used * while changing the source string, saving object creation. * @draft ICU 2.4 */ @@ -153,7 +153,8 @@ public final class CanonicalIterator { * Simple implementation of permutation. *
    Warning: The strings are not guaranteed to be in any particular order. * @param source the string to find permutations for - * @param the set to add the results to + * @param skipZeros set to true to skip characters with canonical combining class zero + * @param output the set to add the results to * @internal */ public static void permute(String source, boolean skipZeros, Set output) { diff --git a/icu4j/src/com/ibm/icu/text/CollationKey.java b/icu4j/src/com/ibm/icu/text/CollationKey.java index ec981ee7652..08dfdb6c9bb 100755 --- a/icu4j/src/com/ibm/icu/text/CollationKey.java +++ b/icu4j/src/com/ibm/icu/text/CollationKey.java @@ -5,8 +5,8 @@ ******************************************************************************* * * $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/text/CollationKey.java,v $ -* $Date: 2003/11/18 17:53:53 $ -* $Revision: 1.20 $ +* $Date: 2003/12/01 23:39:13 $ +* $Revision: 1.21 $ * ******************************************************************************* */ @@ -433,12 +433,12 @@ public final class CollationKey implements Comparable *

    * Collation keys produced may be compared using the compare API. *

    - * @param bound Mode of bound required. It can be BoundMode.LOWER, which + * @param boundType Mode of bound required. It can be BoundMode.LOWER, which * produces a lower inclusive bound, BoundMode.UPPER, that * produces upper bound that matches strings of the same * length or BoundMode.UPPER_LONG that matches strings that * have the same starting substring as the source string. - * @param strength Strength levels required in the resulting bound + * @param noOfLevels Strength levels required in the resulting bound * (for most uses, the recommended value is PRIMARY). This * strength should be less than the maximum strength of * this CollationKey. diff --git a/icu4j/src/com/ibm/icu/text/Collator.java b/icu4j/src/com/ibm/icu/text/Collator.java index 18760a8e0d3..0d9cb9d05d7 100755 --- a/icu4j/src/com/ibm/icu/text/Collator.java +++ b/icu4j/src/com/ibm/icu/text/Collator.java @@ -5,8 +5,8 @@ ******************************************************************************* * * $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/text/Collator.java,v $ -* $Date: 2003/11/21 22:52:05 $ -* $Revision: 1.38 $ +* $Date: 2003/12/01 23:39:13 $ +* $Revision: 1.39 $ * ******************************************************************************* */ @@ -229,7 +229,7 @@ public abstract class Collator implements Comparator, Cloneable * otherwise by the locale used to create the Collator.

    * *

    See the Collator class description for an example of use.

    - * @param new Strength the new strength value. + * @param newStrength the new strength value. * @see #getStrength * @see #PRIMARY * @see #SECONDARY diff --git a/icu4j/src/com/ibm/icu/text/DateFormat.java b/icu4j/src/com/ibm/icu/text/DateFormat.java index 0f399e7bb83..0a41d873bd1 100755 --- a/icu4j/src/com/ibm/icu/text/DateFormat.java +++ b/icu4j/src/com/ibm/icu/text/DateFormat.java @@ -96,7 +96,7 @@ import java.util.MissingResourceException; * format instances for each thread. If multiple threads access a format * concurrently, it must be synchronized externally. * - * @see Format + * @see UFormat * @see NumberFormat * @see SimpleDateFormat * @see com.ibm.icu.util.Calendar diff --git a/icu4j/src/com/ibm/icu/text/DictionaryBasedBreakIterator.java b/icu4j/src/com/ibm/icu/text/DictionaryBasedBreakIterator.java index 6de5fed38bc..f11c743120d 100755 --- a/icu4j/src/com/ibm/icu/text/DictionaryBasedBreakIterator.java +++ b/icu4j/src/com/ibm/icu/text/DictionaryBasedBreakIterator.java @@ -5,8 +5,8 @@ ******************************************************************************* * * $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/text/DictionaryBasedBreakIterator.java,v $ - * $Date: 2003/12/01 22:03:53 $ - * $Revision: 1.14 $ + * $Date: 2003/12/01 23:39:13 $ + * $Revision: 1.15 $ * ***************************************************************************************** */ @@ -92,7 +92,7 @@ public class DictionaryBasedBreakIterator extends RuleBasedBreakIterator { * @param description Same as the description parameter on RuleBasedBreakIterator, * except for the special meaning of DICTIONARY_VAR. This parameter is just * passed through to RuleBasedBreakIterator's constructor. - * @param dictionaryFilename The filename of the dictionary file to use + * @param dictionaryStream the stream containing the dictionary data * @stable ICU 2.0 */ public DictionaryBasedBreakIterator(String description, diff --git a/icu4j/src/com/ibm/icu/text/UFormat.java b/icu4j/src/com/ibm/icu/text/UFormat.java index 5089872e0ee..b0ebe452b79 100644 --- a/icu4j/src/com/ibm/icu/text/UFormat.java +++ b/icu4j/src/com/ibm/icu/text/UFormat.java @@ -5,8 +5,8 @@ ******************************************************************************* * * $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/text/UFormat.java,v $ - * $Date: 2003/11/22 01:05:45 $ - * $Revision: 1.3 $ + * $Date: 2003/12/01 23:39:12 $ + * $Revision: 1.4 $ * ******************************************************************************* */ @@ -32,10 +32,9 @@ public abstract class UFormat extends Format { * * @param type The type fo the locale that should returned. * @return ULocale object for the type requested - * @see ULocale.ULocaleDataType * @see ULocale + * @see ULocale#ULocaleDataType * @draft ICU 2.8 */ public abstract ULocale getLocale(ULocale.ULocaleDataType type); - }