From 2c1ab11ef27b94d294219f764c44569d7b4370d2 Mon Sep 17 00:00:00 2001 From: Doug Felt Date: Tue, 2 Dec 2003 01:34:32 +0000 Subject: [PATCH] ICU-3027 clean up tags in docs X-SVN-Rev: 13928 --- icu4j/src/com/ibm/icu/text/IDNA.java | 56 +++++++++---------- icu4j/src/com/ibm/icu/text/Normalizer.java | 41 +++++++------- .../com/ibm/icu/text/RuleBasedCollator.java | 6 +- .../src/com/ibm/icu/text/SearchIterator.java | 8 +-- .../com/ibm/icu/text/SimpleDateFormat.java | 10 ++-- icu4j/src/com/ibm/icu/text/StringSearch.java | 6 +- .../src/com/ibm/icu/text/Transliterator.java | 5 +- icu4j/src/com/ibm/icu/text/UFormat.java | 5 +- icu4j/src/com/ibm/icu/text/UTF16.java | 28 +++++----- icu4j/src/com/ibm/icu/text/UnicodeSet.java | 8 +-- icu4j/src/com/ibm/icu/util/Calendar.java | 14 ++--- .../com/ibm/icu/util/CalendarAstronomer.java | 6 +- .../src/com/ibm/icu/util/ChineseCalendar.java | 6 +- icu4j/src/com/ibm/icu/util/Holiday.java | 6 +- .../src/com/ibm/icu/util/IslamicCalendar.java | 8 +-- icu4j/src/com/ibm/icu/util/TimeZone.java | 2 +- icu4j/src/com/ibm/icu/util/ValueIterator.java | 12 ++-- .../ibm/richtext/demo/EditApplication.java | 6 +- .../com/ibm/richtext/styledtext/MText.java | 6 +- .../ibm/richtext/styledtext/StyledText.java | 8 +-- .../ibm/richtext/textformat/MFormatter.java | 8 ++- .../ibm/richtext/textformat/TextOffset.java | 4 +- .../textlayout/attributes/AttributeMap.java | 10 ++-- .../ibm/richtext/textpanel/JTextPanel.java | 4 +- .../ibm/richtext/textpanel/MTextPanel.java | 4 +- .../com/ibm/richtext/textpanel/TextPanel.java | 4 +- .../richtext/textpanel/TextPanelSettings.java | 6 +- 27 files changed, 143 insertions(+), 144 deletions(-) diff --git a/icu4j/src/com/ibm/icu/text/IDNA.java b/icu4j/src/com/ibm/icu/text/IDNA.java index fe55f91844c..932c712d66c 100644 --- a/icu4j/src/com/ibm/icu/text/IDNA.java +++ b/icu4j/src/com/ibm/icu/text/IDNA.java @@ -4,8 +4,8 @@ * others. All Rights Reserved. * ******************************************************************************* * $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/text/IDNA.java,v $ - * $Date: 2003/11/21 22:43:41 $ - * $Revision: 1.4 $ + * $Date: 2003/12/02 01:34:32 $ + * $Revision: 1.5 $ * ***************************************************************************************** */ @@ -300,7 +300,7 @@ public final class IDNA { * @throws ParseException * @draft ICU 2.8 */ - public static StringBuffer convertToASCII(UCharacterIterator srcIter, int options) + public static StringBuffer convertToASCII(UCharacterIterator src, int options) throws StringPrepParseException{ boolean[] caseFlags = null; @@ -315,7 +315,7 @@ public final class IDNA { int failPos = -1; // step 2 - StringBuffer processOut = singleton.namePrep.prepare(srcIter,options); + StringBuffer processOut = singleton.namePrep.prepare(src, options); int poLen = processOut.length(); StringBuffer dest = new StringBuffer(); // step 3 & 4 @@ -401,7 +401,7 @@ public final class IDNA { * and then convert. This function does not offer that level of granularity. The options once * set will apply to all labels in the domain name * - * @param iter The input string as UCharacterIterator to be processed + * @param src The input string as UCharacterIterator to be processed * @param options A bit set of options: * - IDNA.DEFAULT Use default options, i.e., do not process unassigned code points * and do not use STD3 ASCII rules @@ -419,9 +419,9 @@ public final class IDNA { * @throws ParseException * @draft ICU 2.8 */ - public static StringBuffer convertIDNToASCII(UCharacterIterator iter,int options) + public static StringBuffer convertIDNToASCII(UCharacterIterator src, int options) throws StringPrepParseException{ - return convertIDNToASCII(iter.getText(), options); + return convertIDNToASCII(src.getText(), options); } /** @@ -436,7 +436,7 @@ public final class IDNA { * and then convert. This function does not offer that level of granularity. The options once * set will apply to all labels in the domain name * - * @param src The input string as StringBuffer to be processed + * @param src The input string as a StringBuffer to be processed * @param options A bit set of options: * - IDNA.DEFAULT Use default options, i.e., do not process unassigned code points * and do not use STD3 ASCII rules @@ -454,9 +454,9 @@ public final class IDNA { * @throws ParseException * @draft ICU 2.8 */ - public static StringBuffer convertIDNToASCII(StringBuffer str,int options) + public static StringBuffer convertIDNToASCII(StringBuffer src, int options) throws StringPrepParseException{ - return convertIDNToASCII(str.toString(), options); + return convertIDNToASCII(src.toString(), options); } /** @@ -581,7 +581,7 @@ public final class IDNA { * separated by dots; for e.g." "www.example.com" is composed of 3 labels * "www","example", and "com". * - * @param iter The input string as UCharacterIterator to be processed + * @param src The input string as UCharacterIterator to be processed * @param options A bit set of options: * - IDNA.DEFAULT Use default options, i.e., do not process unassigned code points * and do not use STD3 ASCII rules @@ -599,7 +599,7 @@ public final class IDNA { * @throws ParseException * @draft ICU 2.8 */ - public static StringBuffer convertToUnicode(UCharacterIterator iter, int options) + public static StringBuffer convertToUnicode(UCharacterIterator src, int options) throws StringPrepParseException{ boolean[] caseFlags = null; @@ -614,26 +614,26 @@ public final class IDNA { int failPos = -1; int ch; - int saveIndex = iter.getIndex(); + int saveIndex = src.getIndex(); // step 1: find out if all the codepoints in src are ASCII - while((ch=iter.next())!= UCharacterIterator.DONE){ + while((ch=src.next())!= UCharacterIterator.DONE){ if(ch>0x7F){ srcIsASCII = false; } if((srcIsLDH = isLDHChar(ch))==false){ - failPos = iter.getIndex(); + failPos = src.getIndex(); } } StringBuffer processOut; if(srcIsASCII == false){ // step 2: process the string - iter.setIndex(saveIndex); - processOut = singleton.namePrep.prepare(iter,options); + src.setIndex(saveIndex); + processOut = singleton.namePrep.prepare(src,options); }else{ //just point to source - processOut = new StringBuffer(iter.getText()); + processOut = new StringBuffer(src.getText()); } // TODO: // The RFC states that @@ -689,7 +689,7 @@ public final class IDNA { } } // just return the source - return new StringBuffer(iter.getText()); + return new StringBuffer(src.getText()); } } @@ -702,7 +702,7 @@ public final class IDNA { * and then convert. This function does not offer that level of granularity. The options once * set will apply to all labels in the domain name * - * @param iter The input string as UCharacterIterator to be processed + * @param src The input string as UCharacterIterator to be processed * @param options A bit set of options: * - IDNA.DEFAULT Use default options, i.e., do not process unassigned code points * and do not use STD3 ASCII rules @@ -720,9 +720,9 @@ public final class IDNA { * @throws ParseException * @draft ICU 2.8 */ - public static StringBuffer convertIDNToUnicode(UCharacterIterator iter, int options) + public static StringBuffer convertIDNToUnicode(UCharacterIterator src, int options) throws StringPrepParseException{ - return convertIDNToUnicode(iter.getText(), options); + return convertIDNToUnicode(src.getText(), options); } /** @@ -752,9 +752,9 @@ public final class IDNA { * @throws ParseException * @draft ICU 2.8 */ - public static StringBuffer convertIDNToUnicode(StringBuffer str, int options) + public static StringBuffer convertIDNToUnicode(StringBuffer src, int options) throws StringPrepParseException{ - return convertIDNToUnicode(str.toString(), options); + return convertIDNToUnicode(src.toString(), options); } /** @@ -912,13 +912,13 @@ public final class IDNA { * @draft ICU 2.8 */ // TODO: optimize - public static int compare(UCharacterIterator i1, UCharacterIterator i2, int options) + public static int compare(UCharacterIterator s1, UCharacterIterator s2, int options) throws StringPrepParseException{ - if(i1==null || i2 == null){ + if(s1==null || s2 == null){ throw new IllegalArgumentException("One of the source buffers is null"); } - StringBuffer s1Out = convertIDNToASCII(i1.getText(), options); - StringBuffer s2Out = convertIDNToASCII(i2.getText(), options); + StringBuffer s1Out = convertIDNToASCII(s1.getText(), options); + StringBuffer s2Out = convertIDNToASCII(s2.getText(), options); return compareCaseInsensitiveASCII(s1Out,s2Out); } } diff --git a/icu4j/src/com/ibm/icu/text/Normalizer.java b/icu4j/src/com/ibm/icu/text/Normalizer.java index 672011ae771..51c313f6a4b 100755 --- a/icu4j/src/com/ibm/icu/text/Normalizer.java +++ b/icu4j/src/com/ibm/icu/text/Normalizer.java @@ -5,8 +5,8 @@ ******************************************************************************* * * $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/text/Normalizer.java,v $ - * $Date: 2003/11/24 22:16:56 $ - * $Revision: 1.37 $ + * $Date: 2003/12/02 01:34:31 $ + * $Revision: 1.38 $ * ******************************************************************************* */ @@ -1057,10 +1057,10 @@ public final class Normalizer implements Cloneable{ * Unicode Normalization Forms, use 0 for this argument. *

* @param str the input string to be normalized. - * @param aMode the normalization mode + * @param mode the normalization mode * @param options the optional features to be enabled. * @return String the normalized string - * @draft ICU 2.6 + * @draft ICU 2.6 */ public static String normalize(String str, Mode mode, int options){ return mode.normalize(str,options); @@ -1070,15 +1070,15 @@ public final class Normalizer implements Cloneable{ * Normalize a string. * The string will be normalized according the the specified normalization * mode and options. - * @param source The string to normalize. + * @param src The string to normalize. * @param mode The normalization mode; one of Normalizer.NONE, * Normalizer.NFD, Normalizer.NFC, Normalizer.NFKC, * Normalizer.NFKD, Normalizer.DEFAULT - * @return String The normalized string + * @return the normalized string * @stable ICU 2.8 * */ - public static String normalize( String src,Mode mode){ + public static String normalize(String src,Mode mode){ return normalize(src, mode, 0); } /** @@ -1141,7 +1141,7 @@ public final class Normalizer implements Cloneable{ /** * Normalize a codepoint accoding to the given mode * @param char32 The input string to be normalized. - * @param aMode The normalization mode + * @param mode The normalization mode * @param options Options for use with exclusion set an tailored Normalization * The only option that is currently recognized is UNICODE_3_2 * @return String The normalized string @@ -1156,7 +1156,7 @@ public final class Normalizer implements Cloneable{ /** * Conveinience method to normalize a codepoint accoding to the given mode * @param char32 The input string to be normalized. - * @param aMode The normalization mode + * @param mode The normalization mode * @return String The normalized string * @see #UNICODE_3_2 * @draft ICU 2.6 @@ -1261,7 +1261,7 @@ public final class Normalizer implements Cloneable{ * it is normalized * @param start The strart index in the source * @param limit The limit index in the source - * @param aMode the normalization mode + * @param mode the normalization mode * @param options Options for use with exclusion set an tailored Normalization * The only option that is currently recognized is UNICODE_3_2 * @return Boolean value indicating whether the source string is in the @@ -1278,7 +1278,7 @@ public final class Normalizer implements Cloneable{ * Convenience Method * @param str the input string to be checked to see if it is * normalized - * @param aMode the normalization mode + * @param mode the normalization mode * @param options Options for use with exclusion set an tailored Normalization * The only option that is currently recognized is UNICODE_3_2 * @see #isNormalized @@ -1292,7 +1292,7 @@ public final class Normalizer implements Cloneable{ * Convenience Method * @param char32 the input code point to be checked to see if it is * normalized - * @param aMode the normalization mode + * @param mode the normalization mode * @param options Options for use with exclusion set an tailored Normalization * The only option that is currently recognized is UNICODE_3_2 @@ -1451,8 +1451,7 @@ public final class Normalizer implements Cloneable{ * by not allocating buffers. * @param char32a the first code point to be checked against the * @param char32b the second code point - * @param options A bit set of options - * @param aMode the normalization mode + * @param options A bit set of options * @stable ICU 2.8 */ // TODO: actually do the optimization when the guts of Normalizer are @@ -1469,7 +1468,6 @@ public final class Normalizer implements Cloneable{ * @param char32a the first code point to be checked against the * @param str2 the second string * @param options A bit set of options - * @param aMode the normalization mode * @stable ICU 2.8 * */ @@ -1500,14 +1498,15 @@ public final class Normalizer implements Cloneable{ * It is allowed to have dest==left to avoid copying the entire left string. * * @param left Left source array, may be same as dest. - * @param leftStart start index of the left array. - * @param leftLimit end index of the left array (==length) + * @param leftStart start in the left array. + * @param leftLimit limit in the left array (==length) * @param right Right source array. - * @param rightStart start index of the right array. - * @param leftLimit end index of the right array (==length) + * @param rightStart start in the right array. + * @param rightLimit limit in the right array (==length) * @param dest The output buffer; can be null if destStart==destLimit==0 * for pure preflighting. - * @param destStart start index of the destination array + * @param destStart start in the destination array + * @param destLimit limit in the destination array (==length) * @param mode The normalization mode. * @param options The normalization options, ORed together (0 for no options). * @return Length of output (number of chars) when successful or @@ -2049,7 +2048,7 @@ public final class Normalizer implements Cloneable{ /** * Returns the text under iteration as a string - * @param result a copy of the text under iteration. + * @return a copy of the text under iteration. * @stable ICU 2.8 */ public String getText(){ diff --git a/icu4j/src/com/ibm/icu/text/RuleBasedCollator.java b/icu4j/src/com/ibm/icu/text/RuleBasedCollator.java index fa71450b7ec..4cdbaa632c4 100755 --- a/icu4j/src/com/ibm/icu/text/RuleBasedCollator.java +++ b/icu4j/src/com/ibm/icu/text/RuleBasedCollator.java @@ -5,8 +5,8 @@ ******************************************************************************* * * $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/text/RuleBasedCollator.java,v $ -* $Date: 2003/11/21 19:46:25 $ -* $Revision: 1.52 $ +* $Date: 2003/12/02 01:34:31 $ +* $Revision: 1.53 $ * ******************************************************************************* */ @@ -558,7 +558,7 @@ public final class RuleBasedCollator extends Collator * during comparison. *

*

See the Collator class description for an example of use.

- * @param the new strength value. + * @param newStrength the new strength value. * @see #getStrength * @see #setStrengthDefault * @see #PRIMARY diff --git a/icu4j/src/com/ibm/icu/text/SearchIterator.java b/icu4j/src/com/ibm/icu/text/SearchIterator.java index a3d68a707aa..e89b74dbf1b 100755 --- a/icu4j/src/com/ibm/icu/text/SearchIterator.java +++ b/icu4j/src/com/ibm/icu/text/SearchIterator.java @@ -5,8 +5,8 @@ ******************************************************************************* * * $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/text/SearchIterator.java,v $ - * $Date: 2003/11/18 17:53:53 $ - * $Revision: 1.16 $ + * $Date: 2003/12/02 01:34:31 $ + * $Revision: 1.17 $ * ***************************************************************************************** */ @@ -755,7 +755,7 @@ public abstract class SearchIterator * {@link #getIndex}, is the starting position of the match if one was * found. If a match is not found, DONE will be returned. *

- * @param start index in the target text at which the backwards search + * @param startAt index in the target text at which the backwards search * should begin. * @return the starting index of the next backwards match if found, * DONE otherwise @@ -763,7 +763,7 @@ public abstract class SearchIterator * @see #handleNext(int) * @see #DONE * @stable ICU 2.0 - */ + */ protected abstract int handlePrevious(int startAt); // private data members ------------------------------------------------ diff --git a/icu4j/src/com/ibm/icu/text/SimpleDateFormat.java b/icu4j/src/com/ibm/icu/text/SimpleDateFormat.java index 96170b11a8e..d77bc7ff068 100755 --- a/icu4j/src/com/ibm/icu/text/SimpleDateFormat.java +++ b/icu4j/src/com/ibm/icu/text/SimpleDateFormat.java @@ -5,8 +5,8 @@ ******************************************************************************* * * $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/text/SimpleDateFormat.java,v $ - * $Date: 2003/10/02 20:50:25 $ - * $Revision: 1.24 $ + * $Date: 2003/12/02 01:34:31 $ + * $Revision: 1.25 $ * ***************************************************************************************** */ @@ -407,8 +407,8 @@ public class SimpleDateFormat extends DateFormat { * since January 1, 1970, 00:00:00 GMT. *

Example: using the US locale: * "yyyy.MM.dd G 'at' HH:mm:ss zzz" ->> 1996.07.10 AD at 15:08:56 PDT - * @param date the date-time value to be formatted into a date-time string. - * @param toAppendTo where the new date-time text is to be appended. + * @param cal the calendar whose date-time value is to be formatted into a date-time string + * @param toAppendTo where the new date-time text is to be appended * @param pos the formatting position. On input: an alignment field, * if desired. On output: the offsets of the alignment field. * @return the formatted date-time string. @@ -1403,7 +1403,7 @@ public class SimpleDateFormat extends DateFormat { /** * Allows you to set the date/time formatting data. - * @param newFormatData the given date-time formatting data. + * @param newFormatSymbols the new symbols * @stable ICU 2.0 */ public void setDateFormatSymbols(DateFormatSymbols newFormatSymbols) diff --git a/icu4j/src/com/ibm/icu/text/StringSearch.java b/icu4j/src/com/ibm/icu/text/StringSearch.java index 976f845109c..e345eea9385 100755 --- a/icu4j/src/com/ibm/icu/text/StringSearch.java +++ b/icu4j/src/com/ibm/icu/text/StringSearch.java @@ -5,8 +5,8 @@ ******************************************************************************* * * $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/text/StringSearch.java,v $ - * $Date: 2003/11/18 17:53:53 $ - * $Revision: 1.27 $ + * $Date: 2003/12/02 01:34:31 $ + * $Revision: 1.28 $ * ***************************************************************************************** */ @@ -165,7 +165,7 @@ public final class StringSearch extends SearchIterator * @param pattern text to look for. * @param target target text to search for pattern. * @param collator RuleBasedCollator that defines the language rules - * @param breaker A {@link BreakIterator} that is used to determine the + * @param breakiter A {@link BreakIterator} that is used to determine the * boundaries of a logical match. This argument can be null. * @exception IllegalArgumentException thrown when argument target is null, * or of length 0 diff --git a/icu4j/src/com/ibm/icu/text/Transliterator.java b/icu4j/src/com/ibm/icu/text/Transliterator.java index a3407ddc191..03934e3dbbf 100755 --- a/icu4j/src/com/ibm/icu/text/Transliterator.java +++ b/icu4j/src/com/ibm/icu/text/Transliterator.java @@ -5,8 +5,8 @@ ******************************************************************************* * * $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/text/Transliterator.java,v $ - * $Date: 2003/11/22 01:07:24 $ - * $Revision: 1.92 $ + * $Date: 2003/12/02 01:34:31 $ + * $Revision: 1.93 $ * ***************************************************************************************** */ @@ -1592,7 +1592,6 @@ public abstract class Transliterator { /** * Register a Transliterator object with the given ID. - * @param ID the ID of this transliterator * @param trans the Transliterator object * @stable ICU 2.2 */ diff --git a/icu4j/src/com/ibm/icu/text/UFormat.java b/icu4j/src/com/ibm/icu/text/UFormat.java index b0ebe452b79..5d4a73672b0 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/12/01 23:39:12 $ - * $Revision: 1.4 $ + * $Date: 2003/12/02 01:34:31 $ + * $Revision: 1.5 $ * ******************************************************************************* */ @@ -33,7 +33,6 @@ 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 - * @see ULocale#ULocaleDataType * @draft ICU 2.8 */ public abstract ULocale getLocale(ULocale.ULocaleDataType type); diff --git a/icu4j/src/com/ibm/icu/text/UTF16.java b/icu4j/src/com/ibm/icu/text/UTF16.java index 638e83adbf2..cd849a6be12 100755 --- a/icu4j/src/com/ibm/icu/text/UTF16.java +++ b/icu4j/src/com/ibm/icu/text/UTF16.java @@ -5,8 +5,8 @@ ******************************************************************************* * * $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/text/UTF16.java,v $ -* $Date: 2003/06/18 00:58:21 $ -* $Revision: 1.32 $ +* $Date: 2003/12/02 01:34:31 $ +* $Revision: 1.33 $ * ******************************************************************************* */ @@ -413,7 +413,7 @@ public final class UTF16 * If a validity check is required, use * isLegal() on * char32 before calling. - * @param ch the input codepoint. + * @param char32 the input codepoint. * @return 2 if is in supplementary space, otherwise 1. * @stable ICU 2.1 */ @@ -565,7 +565,7 @@ public final class UTF16 /** * Determines whether the code value is a surrogate. - * @param ch the input character. + * @param char16 the input character. * @return true iff the input character is a surrogate. * @stable ICU 2.1 */ @@ -1288,7 +1288,7 @@ public final class UTF16 /** * Shifts offset16 by the argument number of codepoints - * @param target string buffer + * @param source string buffer * @param offset16 UTF16 position to shift * @param shift32 number of codepoints to shift * @return new shifted offset16 @@ -1325,7 +1325,7 @@ public final class UTF16 /** * Shifts offset16 by the argument number of codepoints within a subarray. - * @param target char array + * @param source char array * @param start position of the subarray to be performed on * @param limit position of the subarray to be performed on * @param offset16 UTF16 position to shift relative to start @@ -2011,7 +2011,7 @@ public final class UTF16 /** * Returns a new UTF16 format Unicode string resulting from replacing all * occurrences of oldStr in source with newStr. - * If the character oldStr does not occur in the UTF16 format Unicode + * If the string oldStr does not occur in the UTF16 format Unicode * string source, then source will be returned. Otherwise, a new String * object is created that represents a codepoint sequence identical to the * codepoint sequence represented by source, except that every occurrence @@ -2021,7 +2021,7 @@ public final class UTF16 * UTF16.replace("mesquite in your cellar", "e", "o");
* returns "mosquito in your collar"
* UTF16.replace("mesquite in your cellar", "mesquite", "cat");
- * returns "cat in your collar"
+ * returns "cat in your cellar"
* UTF16.replace("JonL", "q", "x");
* returns "JonL" (no change)
* UTF16.replace("Supplementary character \ud800\udc00", "\ud800\udc00", @@ -2032,13 +2032,13 @@ public final class UTF16 *

* Note this method is provided as support to jdk 1.3, which does not * support supplementary characters to its fullest. - * @param source UTF16 format Unicode string which the codepoint + * @param source UTF16 format Unicode string which the * replacements will be based on. - * @param oldChar32 non-zero old codepoint to be replaced. - * @param newChar32 the new codepoint to replace oldChar32 + * @param oldStr non-zero-length string to be replaced. + * @param newStr the new string to replace oldStr * @return new String derived from source by replacing every occurrence - * of oldChar32 with newChar32, unless when no oldChar32 is found - * in source then source will be returned. + * of oldStr with newStr. When no oldStr is found + * in source, then source will be returned. * @stable ICU 2.6 */ public static String replace(String source, String oldStr, @@ -2413,7 +2413,7 @@ public final class UTF16 * is true, otherwise case sensitive comparison mode if set to false. * @param ignorecase true for case-insitive comparison, false for * case sensitive comparison - * @param foldcaseoptions FOLD_CASE_DEFAULT or + * @param foldcaseoption FOLD_CASE_DEFAULT or * FOLD_CASE_EXCLUDE_SPECIAL_I. This option is used only when * ignorecase is set to true. If ignorecase is false, this option * is ignored. diff --git a/icu4j/src/com/ibm/icu/text/UnicodeSet.java b/icu4j/src/com/ibm/icu/text/UnicodeSet.java index 1deb05fddaf..864b0de63ce 100755 --- a/icu4j/src/com/ibm/icu/text/UnicodeSet.java +++ b/icu4j/src/com/ibm/icu/text/UnicodeSet.java @@ -5,8 +5,8 @@ ******************************************************************************* * * $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/text/UnicodeSet.java,v $ - * $Date: 2003/11/25 00:34:56 $ - * $Revision: 1.104 $ + * $Date: 2003/12/02 01:34:31 $ + * $Revision: 1.105 $ * ***************************************************************************************** */ @@ -1218,7 +1218,7 @@ public class UnicodeSet extends UnicodeFilter { * Retain the specified character from this set if it is present. * Upon return this set will be empty if it did not contain c, or * will only contain c if it did contain c. - * @param s the character to be retained + * @param c the character to be retained * @return this object, for chaining * @stable ICU 2.0 */ @@ -1714,7 +1714,7 @@ public class UnicodeSet extends UnicodeFilter { /** * Returns true if this set contains one or more of the characters * and strings of the given set. - * @param c set to be checked for containment + * @param s set to be checked for containment * @return true if the condition is met * @stable ICU 2.0 */ diff --git a/icu4j/src/com/ibm/icu/util/Calendar.java b/icu4j/src/com/ibm/icu/util/Calendar.java index 044441d5080..f06c43ab419 100755 --- a/icu4j/src/com/ibm/icu/util/Calendar.java +++ b/icu4j/src/com/ibm/icu/util/Calendar.java @@ -1741,7 +1741,7 @@ public abstract class Calendar implements Serializable, Cloneable { /** * Sets this Calendar's current time from the given long value. - * @param date the new time in UTC milliseconds from the epoch. + * @param millis the new time in UTC milliseconds from the epoch. * @stable ICU 2.0 */ public void setTimeInMillis( long millis ) { @@ -2950,14 +2950,14 @@ public abstract class Calendar implements Serializable, Cloneable { * {@link #DAY_OF_MONTH DAY_OF_MONTH} whose week number is desired. * Should be 1 for the first day of the period. * - * @param knownDayOfPeriod The {@link #DAY_OF_YEAR DAY_OF_YEAR} + * @param dayOfPeriod The {@link #DAY_OF_YEAR DAY_OF_YEAR} * or {@link #DAY_OF_MONTH DAY_OF_MONTH} for a day in the period whose * {@link #DAY_OF_WEEK DAY_OF_WEEK} is specified by the - * knownDayOfWeek parameter. + * dayOfWeek parameter. * Should be 1 for first day of period. * - * @param knownDayOfWeek The {@link #DAY_OF_WEEK DAY_OF_WEEK} for the day - * corresponding to the knownDayOfPeriod parameter. + * @param dayOfWeek The {@link #DAY_OF_WEEK DAY_OF_WEEK} for the day + * corresponding to the dayOfPeriod parameter. * 1-based with 1=Sunday. * * @return The week number (one-based), or zero if the day falls before @@ -3007,7 +3007,7 @@ public abstract class Calendar implements Serializable, Cloneable { * {@link #DAY_OF_MONTH DAY_OF_MONTH} whose week number is desired. * Should be 1 for the first day of the period. * - * @param dayofWeek The {@link #DAY_OF_WEEK DAY_OF_WEEK} for the day + * @param dayOfWeek The {@link #DAY_OF_WEEK DAY_OF_WEEK} for the day * corresponding to the dayOfPeriod parameter. * 1-based with 1=Sunday. * @@ -4341,7 +4341,7 @@ public abstract class Calendar implements Serializable, Cloneable { * @param useMonth if false, compute the day before the first day of * the given year, otherwise, compute the day before the first day of * the given month - * @param return the Julian day number of the day before the first + * @return the Julian day number of the day before the first * day of the given month and year * @stable ICU 2.0 */ diff --git a/icu4j/src/com/ibm/icu/util/CalendarAstronomer.java b/icu4j/src/com/ibm/icu/util/CalendarAstronomer.java index 7ed853ad0bc..6974de61772 100755 --- a/icu4j/src/com/ibm/icu/util/CalendarAstronomer.java +++ b/icu4j/src/com/ibm/icu/util/CalendarAstronomer.java @@ -5,8 +5,8 @@ ******************************************************************************* * * $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/util/Attic/CalendarAstronomer.java,v $ - * $Date: 2003/06/11 22:27:10 $ - * $Revision: 1.18 $ + * $Date: 2003/12/02 01:34:31 $ + * $Revision: 1.19 $ * ***************************************************************************************** */ @@ -289,7 +289,7 @@ public class CalendarAstronomer { * Set the current date and time of this CalendarAstronomer object. All * astronomical calculations are performed based on this time setting. * - * @param aTime the time and date, expressed as a Date object. + * @param date the time and date, expressed as a Date object. * * @see #setTime * @see #getDate diff --git a/icu4j/src/com/ibm/icu/util/ChineseCalendar.java b/icu4j/src/com/ibm/icu/util/ChineseCalendar.java index 985477d8429..cfb1075b6a1 100755 --- a/icu4j/src/com/ibm/icu/util/ChineseCalendar.java +++ b/icu4j/src/com/ibm/icu/util/ChineseCalendar.java @@ -3,8 +3,8 @@ * others. All Rights Reserved. ********************************************************************* * $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/util/ChineseCalendar.java,v $ - * $Date: 2003/10/02 20:50:26 $ - * $Revision: 1.18 $ + * $Date: 2003/12/02 01:34:31 $ + * $Revision: 1.19 $ */ package com.ibm.icu.util; import com.ibm.icu.text.*; @@ -754,7 +754,7 @@ public class ChineseCalendar extends Calendar { * @param eyear the extended year * @param month the zero-based month. The month is also determined * by reading the IS_LEAP_MONTH field. - * @param return the Julian day number of the day before the first + * @return the Julian day number of the day before the first * day of the given month and year * @draft ICU 2.4 */ diff --git a/icu4j/src/com/ibm/icu/util/Holiday.java b/icu4j/src/com/ibm/icu/util/Holiday.java index 3a40e12c5e5..fdf2a1785d6 100755 --- a/icu4j/src/com/ibm/icu/util/Holiday.java +++ b/icu4j/src/com/ibm/icu/util/Holiday.java @@ -5,8 +5,8 @@ ******************************************************************************* * * $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/util/Holiday.java,v $ - * $Date: 2003/12/01 21:30:06 $ - * $Revision: 1.7 $ + * $Date: 2003/12/02 01:34:31 $ + * $Revision: 1.8 $ * ***************************************************************************************** */ @@ -140,7 +140,7 @@ public abstract class Holiday implements DateRule * as a key to look up the holiday's localized name in a ResourceBundle object * named HolidayBundle. * - * @param loc A locale specifying the language in which the name is desired. + * @param locale A locale specifying the language in which the name is desired. * * @see ResourceBundle * @draft ICU 2.8 diff --git a/icu4j/src/com/ibm/icu/util/IslamicCalendar.java b/icu4j/src/com/ibm/icu/util/IslamicCalendar.java index 910fe56c70a..54d0c747916 100755 --- a/icu4j/src/com/ibm/icu/util/IslamicCalendar.java +++ b/icu4j/src/com/ibm/icu/util/IslamicCalendar.java @@ -5,8 +5,8 @@ ******************************************************************************* * * $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/util/IslamicCalendar.java,v $ - * $Date: 2003/10/02 20:50:26 $ - * $Revision: 1.21 $ + * $Date: 2003/12/02 01:34:31 $ + * $Revision: 1.22 $ * ***************************************************************************************** */ @@ -485,8 +485,8 @@ public class IslamicCalendar extends Calendar { /** * Return the length (in days) of the given month. * - * @param year The hijri year - * @param year The hijri month, 0-based + * @param extendedYear The hijri year + * @param month The hijri month, 0-based * @draft ICU 2.4 */ protected int handleGetMonthLength(int extendedYear, int month) { diff --git a/icu4j/src/com/ibm/icu/util/TimeZone.java b/icu4j/src/com/ibm/icu/util/TimeZone.java index 0bf5a954dfc..2ee8866ca4f 100755 --- a/icu4j/src/com/ibm/icu/util/TimeZone.java +++ b/icu4j/src/com/ibm/icu/util/TimeZone.java @@ -495,7 +495,7 @@ abstract public class TimeZone implements Serializable, Cloneable { * associated with the given country. These IDs may be passed to * get() to construct the corresponding TimeZone * object. - * @param a two-letter ISO 3166 country code, or null + * @param country a two-letter ISO 3166 country code, or null * to return zones not associated with any country * @return an array of IDs for system TimeZones in the given * country. If there are none, return a zero-length array. diff --git a/icu4j/src/com/ibm/icu/util/ValueIterator.java b/icu4j/src/com/ibm/icu/util/ValueIterator.java index 34533086c0b..f814ea16bfb 100644 --- a/icu4j/src/com/ibm/icu/util/ValueIterator.java +++ b/icu4j/src/com/ibm/icu/util/ValueIterator.java @@ -5,8 +5,8 @@ ****************************************************************************** * * $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/util/ValueIterator.java,v $ -* $Date: 2003/06/03 18:49:36 $ -* $Revision: 1.11 $ +* $Date: 2003/12/02 01:34:31 $ +* $Revision: 1.12 $ * ****************************************************************************** */ @@ -105,11 +105,11 @@ public interface ValueIterator * If this range is set outside the meaningful range specified by the * implementation, next(element) will always return false. *

- * @param start first integer in range to iterate - * @param limit 1 integer after the last integer in range + * @param start first integer in the range to iterate + * @param limit one more than the last integer in the range * @exception IllegalArgumentException thrown when attempting to set an * illegal range. E.g limit <= start * @stable ICU 2.6 */ - public void setRange(int start, int end); -} \ No newline at end of file + public void setRange(int start, int limit); +} diff --git a/icu4j/src/com/ibm/richtext/demo/EditApplication.java b/icu4j/src/com/ibm/richtext/demo/EditApplication.java index bde0b084a93..f401f63b041 100755 --- a/icu4j/src/com/ibm/richtext/demo/EditApplication.java +++ b/icu4j/src/com/ibm/richtext/demo/EditApplication.java @@ -1,5 +1,5 @@ /* - * @(#)$RCSfile: EditApplication.java,v $ $Revision: 1.4 $ $Date: 2003/06/03 18:49:36 $ + * @(#)$RCSfile: EditApplication.java,v $ $Revision: 1.5 $ $Date: 2003/12/02 01:34:32 $ * * (C) Copyright IBM Corp. 1998-2003. All Rights Reserved. * @@ -80,7 +80,7 @@ public abstract class EditApplication { /** * Remove document from list of documents. Quit application if list * length falls to zero. - * @param document the document to remove + * @param window window of the document to remove */ public final void removeDocumentWindow(DocumentWindow window) { @@ -118,4 +118,4 @@ public abstract class EditApplication { System.exit(0); } -} \ No newline at end of file +} diff --git a/icu4j/src/com/ibm/richtext/styledtext/MText.java b/icu4j/src/com/ibm/richtext/styledtext/MText.java index d0149feb465..fd357828da8 100755 --- a/icu4j/src/com/ibm/richtext/styledtext/MText.java +++ b/icu4j/src/com/ibm/richtext/styledtext/MText.java @@ -1,5 +1,5 @@ /* - * @(#)$RCSfile: MText.java,v $ $Revision: 1.2 $ $Date: 2002/02/16 03:06:36 $ + * @(#)$RCSfile: MText.java,v $ $Revision: 1.3 $ $Date: 2003/12/02 01:34:32 $ * * (C) Copyright IBM Corp. 1998-1999. All Rights Reserved. * @@ -122,7 +122,7 @@ public abstract class MText extends MConstText * @param start the offset at which the replace operation begins * @param limit the offset at which the replace operation ends. The character and style at * limit is not modified. -* @param srcText the source for the new characters and styles +* @param text the source for the new characters and styles */ public abstract void replace(int start, int limit, MConstText text); @@ -148,7 +148,7 @@ public abstract class MText extends MConstText * @param limit the offset at which the replace operation ends. The character at * limit is not modified. * @param srcChar the new character -* @param charsStyle the style of the new character +* @param charStyle the style of the new character */ public abstract void replace(int start, int limit, char srcChar, AttributeMap charStyle); diff --git a/icu4j/src/com/ibm/richtext/styledtext/StyledText.java b/icu4j/src/com/ibm/richtext/styledtext/StyledText.java index 070f468cb0d..7268942db62 100755 --- a/icu4j/src/com/ibm/richtext/styledtext/StyledText.java +++ b/icu4j/src/com/ibm/richtext/styledtext/StyledText.java @@ -1,5 +1,5 @@ /* - * @(#)$RCSfile: StyledText.java,v $ $Revision: 1.3 $ $Date: 2002/03/20 05:11:17 $ + * @(#)$RCSfile: StyledText.java,v $ $Revision: 1.4 $ $Date: 2003/12/02 01:34:32 $ * * (C) Copyright IBM Corp. 1998-1999. All Rights Reserved. * @@ -358,7 +358,7 @@ public final class StyledText extends MText implements Externalizable * @param start the offset at which the replace operation begins * @param limit the offset at which the replace operation ends. The character and style at * limit is not modified. -* @param srcText the source for the new characters and styles +* @param text the source for the new characters and styles * @param srcStart the offset into srcText where new characters and styles will be obtained * @param srcLimit the offset into srcText where the new characters and styles end */ @@ -389,7 +389,7 @@ public final class StyledText extends MText implements Externalizable * @param start the offset at which the replace operation begins * @param limit the offset at which the replace operation ends. The character and style at * limit is not modified. -* @param srcText the source for the new characters and styles +* @param text the source for the new characters and styles */ public void replace(int start, int limit, MConstText text) { @@ -451,7 +451,7 @@ public final class StyledText extends MText implements Externalizable * @param limit the offset at which the replace operation ends. The character at * limit is not modified. * @param srcChar the new character -* @param charsStyle the style of the new character +* @param charStyle the style of the new character */ public void replace(int start, int limit, char srcChar, AttributeMap charStyle) { diff --git a/icu4j/src/com/ibm/richtext/textformat/MFormatter.java b/icu4j/src/com/ibm/richtext/textformat/MFormatter.java index 4bceb664a8d..6c099c42996 100755 --- a/icu4j/src/com/ibm/richtext/textformat/MFormatter.java +++ b/icu4j/src/com/ibm/richtext/textformat/MFormatter.java @@ -1,5 +1,5 @@ /* - * @(#)$RCSfile: MFormatter.java,v $ $Revision: 1.4 $ $Date: 2002/03/20 05:11:17 $ + * @(#)$RCSfile: MFormatter.java,v $ $Revision: 1.5 $ $Date: 2003/12/02 01:34:32 $ * * (C) Copyright IBM Corp. 1998-1999. All Rights Reserved. * @@ -126,12 +126,13 @@ public abstract class MFormatter { * Specify the number of pixels along the "line dimension". * Lines are formatted to fit within the line dimension. The * line dimension in Roman script is horizontal. -* @param lineWidth the length, in pixels, to which lines will be formatted +* @param lineBound the length, in pixels, to which lines will be formatted */ public abstract void setLineBound(int lineBound); /** * Return the number of pixels along the line dimension. +* @return the number of pixels along the line dimension. */ public abstract int lineBound(); @@ -232,7 +233,8 @@ public abstract class MFormatter { /** * Given two offsets in the text, return a rectangle which encloses the lines containing the offsets. * Offsets do not need to be ordered or nonnegative. -* @param offset1,offset2 offsets into the text +* @param offset1 an offset into the text +* @param offset2 the other offset into the text * @param origin the top-left corner of the text, in the display's coordinate system * @param tight if equal to TIGHT, the bounds is as small as possible. If LOOSE, the width * of the bounds is allowed to be wider than necesary. Loose bounds are easier to compute. diff --git a/icu4j/src/com/ibm/richtext/textformat/TextOffset.java b/icu4j/src/com/ibm/richtext/textformat/TextOffset.java index 9d1c3ebe763..f9a90a17f65 100755 --- a/icu4j/src/com/ibm/richtext/textformat/TextOffset.java +++ b/icu4j/src/com/ibm/richtext/textformat/TextOffset.java @@ -1,5 +1,5 @@ /* - * @(#)$RCSfile: TextOffset.java,v $ $Revision: 1.1 $ $Date: 2000/04/20 17:50:03 $ + * @(#)$RCSfile: TextOffset.java,v $ $Revision: 1.2 $ $Date: 2003/12/02 01:34:32 $ * * (C) Copyright IBM Corp. 1998-1999. All Rights Reserved. * @@ -100,7 +100,7 @@ public final class TextOffset /** * Constructs a new TextOffset from an existing one. - * @param ths the TextOffset to copy + * @param rhs the TextOffset to copy */ public TextOffset(TextOffset rhs) { diff --git a/icu4j/src/com/ibm/richtext/textlayout/attributes/AttributeMap.java b/icu4j/src/com/ibm/richtext/textlayout/attributes/AttributeMap.java index 0a1b4cc2652..49d538d1ddc 100755 --- a/icu4j/src/com/ibm/richtext/textlayout/attributes/AttributeMap.java +++ b/icu4j/src/com/ibm/richtext/textlayout/attributes/AttributeMap.java @@ -1,5 +1,5 @@ /* - * @(#)$RCSfile: AttributeMap.java,v $ $Revision: 1.2 $ $Date: 2002/02/16 03:06:45 $ + * @(#)$RCSfile: AttributeMap.java,v $ $Revision: 1.3 $ $Date: 2003/12/02 01:34:32 $ * * (C) Copyright IBM Corp. 1998-1999. All Rights Reserved. * @@ -95,7 +95,7 @@ public final class AttributeMap implements java.util.Map, /** * Create an AttributeMap with the same key-value * entries as the given Hashtable. - * @param table a Hashtable whose key-value entries will + * @param hashtable a Hashtable whose key-value entries will * become the entries for this AttributeMap. table * is not modified. */ @@ -107,7 +107,7 @@ public final class AttributeMap implements java.util.Map, /** * Create an AttributeMap with a single entry of * {attribute, value}. - * @param attribute the key in this AttributeMap's single entry + * @param key the key in this AttributeMap's single entry * @param value the value in this AttributeMap's single entry */ public AttributeMap(Object key, Object value) { @@ -193,7 +193,7 @@ public final class AttributeMap implements java.util.Map, /** * Return true if the given value is in this AttributeMap. - * @param key the value to test + * @param value the value to test * @return true if value is in this AttributeMap */ public boolean containsValue(Object value) { @@ -526,4 +526,4 @@ public final class AttributeMap implements java.util.Map, rhs.putAll(this); } -} \ No newline at end of file +} diff --git a/icu4j/src/com/ibm/richtext/textpanel/JTextPanel.java b/icu4j/src/com/ibm/richtext/textpanel/JTextPanel.java index 3f8fbf85c31..f2a5e1d8260 100755 --- a/icu4j/src/com/ibm/richtext/textpanel/JTextPanel.java +++ b/icu4j/src/com/ibm/richtext/textpanel/JTextPanel.java @@ -1,5 +1,5 @@ /* - * @(#)$RCSfile: JTextPanel.java,v $ $Revision: 1.6 $ $Date: 2003/06/03 18:49:37 $ + * @(#)$RCSfile: JTextPanel.java,v $ $Revision: 1.7 $ $Date: 2003/12/02 01:34:32 $ * * (C) Copyright IBM Corp. 1998-2003. All Rights Reserved. * @@ -271,7 +271,7 @@ public final class JTextPanel extends JPanel implements MTextPanel { /** * Set the end of the selection range. This is * equivalent to select(getSelectionStart(), selectionEnd). - * @param selectionStart the start of the new selection range + * @param selectionEnd the end of the new selection range */ public void setSelectionEnd(int selectionEnd) { diff --git a/icu4j/src/com/ibm/richtext/textpanel/MTextPanel.java b/icu4j/src/com/ibm/richtext/textpanel/MTextPanel.java index 6311a10517f..13992317b9d 100755 --- a/icu4j/src/com/ibm/richtext/textpanel/MTextPanel.java +++ b/icu4j/src/com/ibm/richtext/textpanel/MTextPanel.java @@ -1,5 +1,5 @@ /* - * @(#)$RCSfile: MTextPanel.java,v $ $Revision: 1.2 $ $Date: 2002/02/16 03:06:47 $ + * @(#)$RCSfile: MTextPanel.java,v $ $Revision: 1.3 $ $Date: 2003/12/02 01:34:32 $ * * (C) Copyright IBM Corp. 1998-1999. All Rights Reserved. * @@ -149,7 +149,7 @@ public interface MTextPanel { /** * Set the end of the selection range. This is * equivalent to select(getSelectionStart(), selectionEnd). - * @param selectionStart the start of the new selection range + * @param selectionEnd the end of the new selection range */ public void setSelectionEnd(int selectionEnd); diff --git a/icu4j/src/com/ibm/richtext/textpanel/TextPanel.java b/icu4j/src/com/ibm/richtext/textpanel/TextPanel.java index 03cd4acf73d..94929832476 100755 --- a/icu4j/src/com/ibm/richtext/textpanel/TextPanel.java +++ b/icu4j/src/com/ibm/richtext/textpanel/TextPanel.java @@ -1,5 +1,5 @@ /* - * @(#)$RCSfile: TextPanel.java,v $ $Revision: 1.5 $ $Date: 2003/06/03 18:49:37 $ + * @(#)$RCSfile: TextPanel.java,v $ $Revision: 1.6 $ $Date: 2003/12/02 01:34:32 $ * * (C) Copyright IBM Corp. 1998-2003. All Rights Reserved. * @@ -242,7 +242,7 @@ public final class TextPanel extends Panel implements MTextPanel { /** * Set the end of the selection range. This is * equivalent to select(getSelectionStart(), selectionEnd). - * @param selectionStart the start of the new selection range + * @param selectionEnd the end of the new selection range */ public void setSelectionEnd(int selectionEnd) { diff --git a/icu4j/src/com/ibm/richtext/textpanel/TextPanelSettings.java b/icu4j/src/com/ibm/richtext/textpanel/TextPanelSettings.java index 1bd69458641..5d4b2d3561a 100755 --- a/icu4j/src/com/ibm/richtext/textpanel/TextPanelSettings.java +++ b/icu4j/src/com/ibm/richtext/textpanel/TextPanelSettings.java @@ -1,5 +1,5 @@ /* - * @(#)$RCSfile: TextPanelSettings.java,v $ $Revision: 1.2 $ $Date: 2002/02/16 03:06:48 $ + * @(#)$RCSfile: TextPanelSettings.java,v $ $Revision: 1.3 $ $Date: 2003/12/02 01:34:32 $ * * (C) Copyright IBM Corp. 1998-1999. All Rights Reserved. * @@ -179,7 +179,7 @@ public final class TextPanelSettings implements Cloneable, Serializable { /** * Set the editable setting. - * @param selectable the selectable setting. If true, + * @param editable the editable setting. If true, * the selectable setting is also set to true. */ public void setEditable(boolean editable) { @@ -280,4 +280,4 @@ public final class TextPanelSettings implements Cloneable, Serializable { return code; } -} \ No newline at end of file +}