AuroraMiddleware/scuffed-code
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

ICU-1795 fix javadoc warnings in ICU4J

Browse Source 
X-SVN-Rev: 8146
This commit is contained in:
Doug Felt 2002-03-20 05:11:17 +00:00
parent e553484ed8
commit 2523c8300a
20 changed files with 148 additions and 145 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
icu4j/build.xml
View File

@ -6,8 +6,8 @@
*******************************************************************************
*
* $Source: /xsrl/Nsvn/icu/icu4j/build.xml,v $
* $Date: 2002/03/18 21:27:45 $
* $Revision: 1.49 $
* $Date: 2002/03/20 05:11:14 $
* $Revision: 1.50 $
*
*******************************************************************************
* This is the ant build file for ICU4J. See readme.html for more information.
@ -35,10 +35,15 @@
<property name="richedit.manifest" value="${richedit.dist.dir}/manifest.stub"/>
<mkdir dir="${build.dir}"/>
<uptodate property="icu4j.resources" targetfile="${src.dir}/com/ibm/icu/impl/data/ICULocaleData.jar">
<!-- note must not have '/' before 'com' in srcfiles includes arg! -->
<srcfiles dir="${build.dir}" includes="com/ibm/icu/impl/data/LocaleElements_index.class"/>
</uptodate>
<uptodate property="icu4j.resources" targetfile="${src.dir}/com/ibm/icu/impl/data/ICULocaleData.jar">
<!-- note must not have '/' before 'com' in srcfiles includes arg! -->
<srcfiles dir="${build.dir}" includes="com/ibm/icu/impl/data/LocaleElements_index.class"/>
</uptodate>
<property name="doc.params" value=""/>
<condition property="doc.params"
value="-breakiterator -tag draft:a:&quot;Draft&quot; -tag internal:X:&quot;Internal&quot;">
<equals arg1="${ant.java.version}" arg2="1.4"/>
</condition>
</target>
<target name="all" depends="core,tests,tools,richtext,demos,jar,docs"/>
@ -108,11 +113,12 @@
sourcepath="${src.dir}"
destdir="${doc.dir}"
nodeprecatedlist="true"
windowtitle="icu4j"
doctitle="icu4j"
encoding="iso-8859-1"
docencoding="iso-8859-1"
bottom="&lt;font size=-1>Copyright (c) 2001 IBM Corporation and others.&lt;/font>"
windowtitle="icu4j"
doctitle="icu4j"
encoding="iso-8859-1"
docencoding="iso-8859-1"
bottom="&lt;font size=-1>Copyright (c) 2001 IBM Corporation and others.&lt;/font>"
additionalparam="${doc.params}"
/>
</target>

58
icu4j/src/com/ibm/icu/lang/UCharacter.java
View File

@ -5,8 +5,8 @@
*******************************************************************************
*
* $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/lang/UCharacter.java,v $
* $Date: 2002/03/15 23:47:10 $
* $Revision: 1.34 $
* $Date: 2002/03/20 05:11:15 $
* $Revision: 1.35 $
*
*******************************************************************************
*/
@ -91,7 +91,7 @@ public final class UCharacter
/**
* The highest Unicode code point value (scalar value) according to the
* Unicode Standard.<br>
* Unicode Standard.
* This is a 21-bit value (21 bits, rounded up).<br>
* Up-to-date Unicode implementation of java.lang.Character.MIN_VALUE
*/
@ -225,7 +225,7 @@ public final class UCharacter
}
/**
* Returns a value indicating a code point's Unicode category.<br>
* Returns a value indicating a code point's Unicode category.
* Up-to-date Unicode implementation of java.lang.Character.getType() except
* for the above mentioned code points that had their category changed.<br>
* Return results are constants from the interface
@ -240,7 +240,7 @@ public final class UCharacter
/**
* Determines if a code point has a defined meaning in the up-to-date Unicode
* standard.<br>
* standard.
* E.g. supplementary code points though allocated space are not defined in
* Unicode yet.<br>
* Up-to-date Unicode implementation of java.lang.Character.isDefined()
@ -269,7 +269,7 @@ public final class UCharacter
}
/**
* Determines if the specified code point is an ISO control character.<br>
* Determines if the specified code point is an ISO control character.
* A code point is considered to be an ISO control character if it is in the
* range &#92u0000 through &#92u001F or in the range &#92u007F through
* &#92u009F.<br>
@ -284,7 +284,7 @@ public final class UCharacter
}
/**
* Determines if the specified code point is a letter.<br>
* Determines if the specified code point is a letter.
* Up-to-date Unicode implementation of java.lang.Character.isLetter()
* @param ch code point to determine if it is a letter
* @return true if code point is a letter
@ -301,7 +301,7 @@ public final class UCharacter
}
/**
* Determines if the specified code point is a letter or digit.<br>
* Determines if the specified code point is a letter or digit.
* Note this method, unlike java.lang.Character does not regard the ascii
* characters 'A' - 'Z' and 'a' - 'z' as digits.
* @param ch code point to determine if it is a letter or a digit
@ -313,7 +313,7 @@ public final class UCharacter
}
/**
* Determines if the specified code point is a lowercase character.<br>
* Determines if the specified code point is a lowercase character.
* UnicodeData only contains case mappings for code points where they are
* one-to-one mappings; it also omits information about context-sensitive
* case mappings.<br> For more information about Unicode case mapping please
@ -330,7 +330,7 @@ public final class UCharacter
}
/**
* Determines if the specified code point is a white space character.<br>
* Determines if the specified code point is a white space character.
* A code point is considered to be an whitespace character if and only
* if it satisfies one of the following criteria:
* <ul>
@ -362,7 +362,7 @@ public final class UCharacter
/**
* Determines if the specified code point is a Unicode specified space
* character, ie if code point is in the category Zs, Zl and Zp.<br>
* character, i.e. if code point is in the category Zs, Zl and Zp.
* Up-to-date Unicode implementation of java.lang.Character.isSpaceChar().
* @param ch code point to determine if it is a space
* @return true if the specified code point is a space character
@ -381,7 +381,7 @@ public final class UCharacter
}
/**
* Determines if the specified code point is a titlecase character.<br>
* Determines if the specified code point is a titlecase character.
* UnicodeData only contains case mappings for code points where they are
* one-to-one mappings; it also omits information about context-sensitive
* case mappings.<br>
@ -401,7 +401,7 @@ public final class UCharacter
/**
* Determines if the specified code point may be any part of a Unicode
* identifier other than the starting character.<br>
* identifier other than the starting character.
* A code point may be part of a Unicode identifier if and only if it is one
* of the following:
* <ul>
@ -444,7 +444,7 @@ public final class UCharacter
/**
* Determines if the specified code point is permissible as the first
* character in a Unicode identifier.<br>
* character in a Unicode identifier.
* A code point may start a Unicode identifier if it is of type either
* <ul>
* <li> Lu Uppercase letter
@ -475,7 +475,7 @@ public final class UCharacter
/**
* Determines if the specified code point should be regarded as an ignorable
* character in a Unicode identifier.<br>
* character in a Unicode identifier.
* A character is ignorable in the Unicode standard if it is of the type Cf,
* Formatting code.<br>
* Up-to-date Unicode implementation of
@ -495,7 +495,7 @@ public final class UCharacter
}
/**
* Determines if the specified code point is an uppercase character.<br>
* Determines if the specified code point is an uppercase character.
* UnicodeData only contains case mappings for code point where they are
* one-to-one mappings; it also omits information about context-sensitive
* case mappings.<br>
@ -519,7 +519,7 @@ public final class UCharacter
/**
* The given code point is mapped to its lowercase equivalent; if the code
* point has no lowercase equivalent, the code point itself is returned.<br>
* point has no lowercase equivalent, the code point itself is returned.
* UnicodeData only contains case mappings for code point where they are
* one-to-one mappings; it also omits information about context-sensitive
* case mappings.<br>
@ -559,7 +559,7 @@ public final class UCharacter
/**
* Converts argument code point and returns a String object representing the
* code point's value in UTF16 format.<br>
* code point's value in UTF16 format.
* The result is a string whose length is 1 for non-supplementary code points,
* 2 otherwise.<br>
* com.ibm.ibm.icu.UTF16 can be used to parse Strings generated by this
@ -586,7 +586,7 @@ public final class UCharacter
}
/**
* Converts the code point argument to titlecase.<br>
* Converts the code point argument to titlecase.
* UnicodeData only contains case mappings for code points where they are
* one-to-one mappings; it also omits information about context-sensitive
* case mappings.<br>
@ -632,7 +632,7 @@ public final class UCharacter
}
/**
* Converts the character argument to uppercase.<br>
* Converts the character argument to uppercase.
* UnicodeData only contains case mappings for characters where they are
* one-to-one mappings; it also omits information about context-sensitive
* case mappings.<br>
@ -670,7 +670,7 @@ public final class UCharacter
// extra methods not in java.lang.Character --------------------------
/**
* Determines if the code point is a supplementary character.<br>
* Determines if the code point is a supplementary character.
* A code point is a supplementary character if and only if it is greater than
* <a href=#SUPPLEMENTARY_MIN_VALUE>SUPPLEMENTARY_MIN_VALUE</a>
* @param ch code point to be determined if it is in the supplementary plane
@ -683,7 +683,7 @@ public final class UCharacter
}
/**
* Determines if the code point is in the BMP plane.<br>
* Determines if the code point is in the BMP plane.
* @param ch code point to be determined if it is not a supplementary
* character
* @return true if code point is not a supplementary character
@ -712,7 +712,7 @@ public final class UCharacter
}
/**
* Determines whether the specified code point is of base form.<br>
* Determines whether the specified code point is of base form.
* A code point of base form does not graphically combine with preceding
* characters, and is neither a control nor a format character.
* @param ch code point to be determined if it is of base form
@ -736,7 +736,7 @@ public final class UCharacter
}
/**
* Returns the Bidirection property of a code point.<br>
* Returns the Bidirection property of a code point.
* For example, 0x0041 (letter A) has the LEFT_TO_RIGHT directional
* property.<br>
* Result returned belongs to the interface
@ -756,7 +756,7 @@ public final class UCharacter
}
/**
* Determines whether the code point has the "mirrored" property.<br>
* Determines whether the code point has the "mirrored" property.
* This property is set for characters that are commonly used in
* Right-To-Left contexts and need to be displayed with a "mirrored"
* glyph.
@ -771,7 +771,7 @@ public final class UCharacter
}
/**
* Maps the specified code point to a "mirror-image" code point.<br>
* Maps the specified code point to a "mirror-image" code point.
* For code points with the "mirrored" property, implementations sometimes
* need a "poor man's" mapping to another code point such that the default
* glyph may serve as the mirror-image of the default glyph of the specified
@ -993,7 +993,7 @@ public final class UCharacter
}
/**
* Returns a code pointcorresponding to the two UTF16 characters.<br>
* Returns a code pointcorresponding to the two UTF16 characters.
* If the argument lead is not a high surrogate character or trail is not a
* low surrogate character, UCharacter.REPLACEMENT_CHAR is returned.
* @param lead the lead char
@ -1013,7 +1013,7 @@ public final class UCharacter
}
/**
* Returns the code point corresponding to the UTF16 character.<br>
* Returns the code point corresponding to the UTF16 character.
* If argument char16 is a surrogate character, UCharacter.REPLACEMENT_CHAR
* is returned
* @param char16 the UTF16 character
@ -1451,7 +1451,7 @@ public final class UCharacter
* <p>Get the "age" of the code point.</p>
* <p>The "age" is the Unicode version when the code point was first
* designated (as a non-character or for Private Use) or assigned a
* character.</p>
* character.
* <p>This can be useful to avoid emitting code points to receiving
* processes that do not accept newer characters.</p>
* <p>The data is from the UCD file DerivedAge.txt.</p>

8
icu4j/src/com/ibm/icu/lang/UProperty.java
View File

@ -6,8 +6,8 @@
*
* $Source:
* /usr/cvs/icu4j/icu4j/src/com/ibm/icu/text/UCharacterCategory.java $
* $Date: 2002/03/13 17:51:20 $
* $Revision: 1.1 $
* $Date: 2002/03/20 05:11:15 $
* $Revision: 1.2 $
*
*******************************************************************************
*/
@ -52,10 +52,10 @@ public interface UProperty
*/
public static final int BINARY_START = ALPHABETIC;
/**
* Binary property ASCII_Hex_Digit. 0-9 A-F a-f.
* Binary property ASCII_Hex_Digit (0-9 A-F a-f).
* @draft ICU 2.1
*/
public static final int ASCII_HEX_DIGIT = 1;
public static final int ASCII_HEX_DIGIT = 1;
/**
* <p>Binary property Bidi_Control.</p>
* <p>Format controls which have specific functions in the Bidi Algorithm.

2
icu4j/src/com/ibm/icu/lang/UScript.java
View File

@ -17,7 +17,7 @@ import java.util.MissingResourceException;
/**
* A class to reflect UTR #24: Script Names
* (based on ISO 15924:2000, "Code for the representation of names of
* scripts".) UTR #24 describes the basis for a new Unicode data file,
* scripts"). UTR #24 describes the basis for a new Unicode data file,
* Scripts.txt.
*/
public final class UScript {

16
icu4j/src/com/ibm/icu/math/BigDecimal.java
View File

@ -296,52 +296,52 @@ public class BigDecimal extends java.lang.Number implements java.io.Serializable
// the rounding modes (copied here for upwards compatibility)
/**
* Rounding mode to round to a more positive number.
* See {@Link MathContext#ROUND_CEILING}.
* @see MathContext#ROUND_CEILING
*/
public static final int ROUND_CEILING=com.ibm.icu.math.MathContext.ROUND_CEILING;
/**
* Rounding mode to round towards zero.
* See {@Link MathContext#ROUND_DOWN}.
* @see MathContext#ROUND_DOWN
*/
public static final int ROUND_DOWN=com.ibm.icu.math.MathContext.ROUND_DOWN;
/**
* Rounding mode to round to a more negative number.
* See {@Link MathContext#ROUND_FLOOR}.
* @see MathContext#ROUND_FLOOR
*/
public static final int ROUND_FLOOR=com.ibm.icu.math.MathContext.ROUND_FLOOR;
/**
* Rounding mode to round to nearest neighbor, where an equidistant
* value is rounded down.
* See {@Link MathContext#ROUND_HALF_DOWN}.
* @see MathContext#ROUND_HALF_DOWN
*/
public static final int ROUND_HALF_DOWN=com.ibm.icu.math.MathContext.ROUND_HALF_DOWN;
/**
* Rounding mode to round to nearest neighbor, where an equidistant
* value is rounded to the nearest even neighbor.
* See {@Link MathContext#ROUND_HALF_EVEN}.
* @see MathContext#ROUND_HALF_EVEN
*/
public static final int ROUND_HALF_EVEN=com.ibm.icu.math.MathContext.ROUND_HALF_EVEN;
/**
* Rounding mode to round to nearest neighbor, where an equidistant
* value is rounded up.
* See {@Link MathContext#ROUND_HALF_UP}.
* @see MathContext#ROUND_HALF_UP
*/
public static final int ROUND_HALF_UP=com.ibm.icu.math.MathContext.ROUND_HALF_UP;
/**
* Rounding mode to assert that no rounding is necessary.
* See {@Link MathContext#ROUND_UNNECESSARY}.
* @see MathContext#ROUND_UNNECESSARY
*/
public static final int ROUND_UNNECESSARY=com.ibm.icu.math.MathContext.ROUND_UNNECESSARY;
/**
* Rounding mode to round away from zero.
* See {@Link MathContext#ROUND_UP}.
* @see MathContext#ROUND_UP
*/
public static final int ROUND_UP=com.ibm.icu.math.MathContext.ROUND_UP;

6
icu4j/src/com/ibm/icu/text/BreakIterator.java
View File

@ -5,8 +5,8 @@
*******************************************************************************
*
* $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/text/BreakIterator.java,v $
* $Date: 2002/03/10 19:40:16 $
* $Revision: 1.7 $
* $Date: 2002/03/20 05:11:15 $
* $Revision: 1.8 $
*
*****************************************************************************************
*/
@ -433,7 +433,7 @@ public abstract class BreakIterator implements Cloneable
* Returns a new instance of BreakIterator that locates legal line-
* wrapping positions. This function assumes the text being broken
* is in the default locale's language.
* @returns A new instance of BreakIterator that locates legal
* @return A new instance of BreakIterator that locates legal
* line-wrapping positions.
*/
public static BreakIterator getLineInstance()

6
icu4j/src/com/ibm/icu/text/Normalizer.java
View File

@ -5,8 +5,8 @@
*******************************************************************************
*
* $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/text/Normalizer.java,v $
* $Date: 2002/02/25 22:43:58 $
* $Revision: 1.15 $
* $Date: 2002/03/20 05:11:15 $
* $Revision: 1.16 $
*
*****************************************************************************************
*/
@ -121,7 +121,7 @@ public final class Normalizer {
/**
* This class represents the mode of a {@link Normalizer}
* object, <i>i.e.</i> the Unicode Normalization Form of the
* object, i.e. the Unicode Normalization Form of the
* text that the <tt>Normalizer</tt> produces. <tt>Mode</tt> objects
* are used as arguments to the {@link Normalizer#Normalizer constructors}
* and {@link Normalizer#setMode setMode} method of <tt>Normalizer</tt>.

16
icu4j/src/com/ibm/icu/text/NumberFormat.java
View File

@ -5,8 +5,8 @@
*******************************************************************************
*
* $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/text/NumberFormat.java,v $
* $Date: 2002/03/10 19:40:16 $
* $Revision: 1.12 $
* $Date: 2002/03/20 05:11:15 $
* $Revision: 1.13 $
*
*****************************************************************************************
*/
@ -151,7 +151,7 @@ import java.util.ResourceBundle;
*
* see DecimalFormat
* see java.text.ChoiceFormat
* @version $Revision: 1.12 $
* @version $Revision: 1.13 $
* @author Mark Davis
* @author Helena Shih
* @author Alan Liu
@ -529,7 +529,7 @@ public abstract class NumberFormat extends Format{
/**
* Sets the maximum number of digits allowed in the integer portion of a
* number. maximumIntegerDigits must be >= minimumIntegerDigits. If the
* number. MaximumIntegerDigits must be >= minimumIntegerDigits. If the
* new value for maximumIntegerDigits is less than the current value
* of minimumIntegerDigits, then minimumIntegerDigits will also be set to
* the new value.
@ -555,7 +555,7 @@ public abstract class NumberFormat extends Format{
/**
* Sets the minimum number of digits allowed in the integer portion of a
* number. minimumIntegerDigits must be <= maximumIntegerDigits. If the
* number. MinimumIntegerDigits must be <= maximumIntegerDigits. If the
* new value for minimumIntegerDigits exceeds the current value
* of maximumIntegerDigits, then maximumIntegerDigits will also be set to
* the new value
@ -581,7 +581,7 @@ public abstract class NumberFormat extends Format{
/**
* Sets the maximum number of digits allowed in the fraction portion of a
* number. maximumFractionDigits must be >= minimumFractionDigits. If the
* number. MaximumFractionDigits must be >= minimumFractionDigits. If the
* new value for maximumFractionDigits is less than the current value
* of minimumFractionDigits, then minimumFractionDigits will also be set to
* the new value.
@ -607,10 +607,10 @@ public abstract class NumberFormat extends Format{
/**
* Sets the minimum number of digits allowed in the fraction portion of a
* number. minimumFractionDigits must be <= maximumFractionDigits. If the
* number. MinimumFractionDigits must be <= maximumFractionDigits. If the
* new value for minimumFractionDigits exceeds the current value
* of maximumFractionDigits, then maximumIntegerDigits will also be set to
* the new value
* the new value.
* @param newValue the minimum number of fraction digits to be shown; if
* less than zero, then zero is used. The concrete subclass may enforce an
* upper limit to this value appropriate to the numeric type being formatted.

11
icu4j/src/com/ibm/icu/text/RuleBasedBreakIterator.java
View File

@ -5,14 +5,13 @@
*******************************************************************************
*
* $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/text/RuleBasedBreakIterator.java,v $
* $Date: 2002/03/01 02:37:47 $
* $Revision: 1.18 $
* $Date: 2002/03/20 05:11:15 $
* $Revision: 1.19 $
*
*****************************************************************************************
*/
//ibm.597
/*
* @(#)RuleBasedBreakIterator.java 1.3 99/04/07
*
@ -241,7 +240,7 @@ import java.io.*;
* &nbsp; For examples, see the resource data (which is annotated).</p>
*
* @author Richard Gillam
* $RCSfile: RuleBasedBreakIterator.java,v $ $Revision: 1.18 $ $Date: 2002/03/01 02:37:47 $
* $RCSfile: RuleBasedBreakIterator.java,v $ $Revision: 1.19 $ $Date: 2002/03/20 05:11:15 $
*/
public class RuleBasedBreakIterator extends BreakIterator {
@ -733,7 +732,7 @@ throws IOException {
/**
* Sets the iterator to refer to the first boundary position following
* the specified position.
* @offset The position from which to begin searching for a break position.
* @param offset The position from which to begin searching for a break position.
* @return The position of the first break after the current position.
*/
public int following(int offset) {
@ -770,7 +769,7 @@ throws IOException {
/**
* Sets the iterator to refer to the last boundary position before the
* specified position.
* @offset The position to begin searching for a break from.
* @param offset The position to begin searching for a break from.
* @return The position of the last boundary before the starting position.
*/
public int preceding(int offset) {

9
icu4j/src/com/ibm/icu/text/SearchIterator.java
View File

@ -5,8 +5,8 @@
*******************************************************************************
*
* $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/text/SearchIterator.java,v $
* $Date: 2002/03/10 19:40:16 $
* $Revision: 1.4 $
* $Date: 2002/03/20 05:11:16 $
* $Revision: 1.5 $
*
*****************************************************************************************
*/
@ -124,8 +124,7 @@ public abstract class SearchIterator {
/**
* Return the index of the next point at which the text matches the
* search pattern, starting from the current position
* <p>
* search pattern, starting from the current position.
* @return The index of the next match after the current position,
* or <code>DONE</code> if there are no more matches.
*
@ -311,7 +310,7 @@ public abstract class SearchIterator {
//-------------------------------------------------------------------
/**
* Constructor for use by subclasses
* Constructor for use by subclasses.
* <p>
* @param target The target text to be searched. This is for internal
* use by this class. Subclasses need to maintain their

6
icu4j/src/com/ibm/icu/text/SimpleDateFormat.java
View File

@ -5,8 +5,8 @@
*******************************************************************************
*
* $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/text/SimpleDateFormat.java,v $
* $Date: 2002/03/10 19:40:16 $
* $Revision: 1.12 $
* $Date: 2002/03/20 05:11:16 $
* $Revision: 1.13 $
*
*****************************************************************************************
*/
@ -380,7 +380,7 @@ public class SimpleDateFormat extends DateFormat {
}
/**
* Overrides DateFormat
* Overrides DateFormat.
* <p>Formats a date or time, which is the standard millis
* since January 1, 1970, 00:00:00 GMT.
* <p>Example: using the US locale:

10
icu4j/src/com/ibm/icu/text/StringSearch.java
View File

@ -5,8 +5,8 @@
*******************************************************************************
*
* $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/text/StringSearch.java,v $
* $Date: 2002/03/10 19:40:16 $
* $Revision: 1.5 $
* $Date: 2002/03/20 05:11:16 $
* $Revision: 1.6 $
*
*****************************************************************************************
*/
@ -97,8 +97,7 @@ public final class StringSearch extends SearchIterator
/**
* Construct a <code>StringSearch</code> object using the collator and
* character boundary detection rules for a given locale
* <p>
* character boundary detection rules for a given locale.
* @param pattern The text for which this object will search.
*
* @param target The text in which to search for the pattern.
@ -117,8 +116,7 @@ public final class StringSearch extends SearchIterator
/**
* Construct a <code>StringSearch</code> object using the collator for the default
* locale
* <p>
* locale.
* @param pattern The text for which this object will search.
*
* @param target The text in which to search for the pattern.

16
icu4j/src/com/ibm/icu/text/UTF16.java
View File

@ -5,8 +5,8 @@
*******************************************************************************
*
* $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/text/UTF16.java,v $
* $Date: 2002/03/20 01:44:49 $
* $Revision: 1.17 $
* $Date: 2002/03/20 05:11:16 $
* $Revision: 1.18 $
*
*******************************************************************************
*/
@ -1512,8 +1512,8 @@ public final class UTF16
/**
* Returns the index within the argument UTF16 format Unicode string of
* the first occurrence of the argument codepoint. ie, the smallest
* index i such that: UTF16.charAt(source, i) == char32 is true.
* the first occurrence of the argument codepoint. I.e., the smallest
* index <code>i</code> such that <code>UTF16.charAt(source, i) == char32</code> is true.
* <p>If no such character occurs in this string, then -1 is returned.</p>
* <p>
* Examples:<br>
@ -1618,7 +1618,7 @@ public final class UTF16
/**
* Returns the index within the argument UTF16 format Unicode string of
* the first occurrence of the argument codepoint. ie, the smallest
* the first occurrence of the argument codepoint. I.e., the smallest
* index i such that: <br>
* (UTF16.charAt(source, i) == char32 && i >= fromIndex) is true.
* <p>If no such character occurs in this string, then -1 is returned.</p>
@ -1728,7 +1728,7 @@ public final class UTF16
/**
* Returns the index within the argument UTF16 format Unicode string of
* the last occurrence of the argument codepoint. ie, the index returned
* the last occurrence of the argument codepoint. I.e., the index returned
* is the largest value i such that: UTF16.charAt(source, i) == char32
* is true.
* <p>
@ -1834,7 +1834,7 @@ public final class UTF16
/**
* Returns the index within the argument UTF16 format Unicode string of
* the last occurrence of the argument codepoint, that occurred before or
* at the index fromIndex. ie, the index returned
* at the index fromIndex. I.e., the index returned
* is the largest value i such that: <br>
* (UTF16.charAt(source, i) == char32 && (i <= fromIndex)) is true.
* <p>source is searched backwards starting at the last character starting
@ -2223,4 +2223,4 @@ public final class UTF16
result.append(getTrailSurrogate(ch));
return result.toString();
}
}
}

40
icu4j/src/com/ibm/icu/text/UnicodeSet.java
View File

@ -5,8 +5,8 @@
*******************************************************************************
*
* $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/text/UnicodeSet.java,v $
* $Date: 2002/03/15 20:09:00 $
* $Revision: 1.65 $
* $Date: 2002/03/20 05:11:16 $
* $Revision: 1.66 $
*
*****************************************************************************************
*/
@ -209,7 +209,7 @@ import java.util.Iterator;
* </table>
* <br><b>Warning: you cannot add an empty string ("") to a UnicodeSet.</b>
* @author Alan Liu
* @version $RCSfile: UnicodeSet.java,v $ $Revision: 1.65 $ $Date: 2002/03/15 20:09:00 $
* @version $RCSfile: UnicodeSet.java,v $ $Revision: 1.66 $ $Date: 2002/03/20 05:11:16 $
*/
public class UnicodeSet extends UnicodeFilter {
@ -360,7 +360,7 @@ public class UnicodeSet extends UnicodeFilter {
* an empty range.
*
* @param start first character in the set, inclusive
* @rparam end last character in the set, inclusive
* @param end last character in the set, inclusive
*/
public UnicodeSet set(int start, int end) {
clear();
@ -907,7 +907,7 @@ public class UnicodeSet extends UnicodeFilter {
* present. If this set already contains the multicharacter,
* the call leaves this set unchanged.
* Thus "ch" => {"ch"}
* @parameter the source string
* @param the source string
* @return the modified set, for chaining
* @internal -- this API is not for general use, and may change at any time.
*/
@ -963,7 +963,7 @@ public class UnicodeSet extends UnicodeFilter {
* the call leaves this set unchanged.
* Thus "ch" => {"ch"}
* <br><b>Warning: you cannot add an empty string ("") to a UnicodeSet.</b>
* @parameter the source string
* @param the source string
* @return the modified set, for chaining
* @internal -- this API is not for general use, and may change at any time.
*/
@ -1002,7 +1002,7 @@ public class UnicodeSet extends UnicodeFilter {
/**
* Adds each of the characters in this string to the set. Thus "ch" => {"c", "h"}
* If this set already any particular character, it has no effect on that character.
* @parameter the source string
* @param the source string
* @return the modified set, for chaining
* @internal -- this API is not for general use, and may change at any time.
*/
@ -1018,7 +1018,7 @@ public class UnicodeSet extends UnicodeFilter {
/**
* Retains EACH of the characters in this string. Note: "ch" == {"c", "h"}
* If this set already any particular character, it has no effect on that character.
* @parameter the source string
* @param the source string
* @return the modified set, for chaining
* @internal -- this API is not for general use, and may change at any time.
*/
@ -1029,7 +1029,7 @@ public class UnicodeSet extends UnicodeFilter {
/**
* Complement EACH of the characters in this string. Note: "ch" == {"c", "h"}
* If this set already any particular character, it has no effect on that character.
* @parameter the source string
* @param the source string
* @return the modified set, for chaining
* @internal -- this API is not for general use, and may change at any time.
*/
@ -1040,7 +1040,7 @@ public class UnicodeSet extends UnicodeFilter {
/**
* Remove EACH of the characters in this string. Note: "ch" == {"c", "h"}
* If this set already any particular character, it has no effect on that character.
* @parameter the source string
* @param the source string
* @return the modified set, for chaining
* @internal -- this API is not for general use, and may change at any time.
*/
@ -1051,7 +1051,7 @@ public class UnicodeSet extends UnicodeFilter {
/**
* Makes a set from a multicharacter string. Thus "ch" => {"ch"}
* <br><b>Warning: you cannot add an empty string ("") to a UnicodeSet.</b>
* @parameter the source string
* @param the source string
* @return the modified set, for chaining
* @internal -- this API is not for general use, and may change at any time.
*/
@ -1062,7 +1062,7 @@ public class UnicodeSet extends UnicodeFilter {
/**
* Makes a set from each of the characters in the string. Thus "ch" => {"c", "h"}
* @parameter the source string
* @param the source string
* @return the modified set, for chaining
* @internal -- this API is not for general use, and may change at any time.
*/
@ -1107,7 +1107,7 @@ public class UnicodeSet extends UnicodeFilter {
* Retain the specified string in this set if it is present.
* The set will not contain the specified character once the call
* returns.
* @parameter the source string
* @param the source string
* @return the modified set, for chaining
* @internal -- this API is not for general use, and may change at any time.
*/
@ -1161,7 +1161,7 @@ public class UnicodeSet extends UnicodeFilter {
* Removes the specified string from this set if it is present.
* The set will not contain the specified character once the call
* returns.
* @parameter the source string
* @param the source string
* @return the modified set, for chaining
* @internal -- this API is not for general use, and may change at any time.
*/
@ -1232,7 +1232,7 @@ public class UnicodeSet extends UnicodeFilter {
* The set will not contain the specified character once the call
* returns.
* <br><b>Warning: you cannot add an empty string ("") to a UnicodeSet.</b>
* @parameter the source string
* @param the source string
* @return the modified set, for chaining
* @internal -- this API is not for general use, and may change at any time.
*/
@ -1272,7 +1272,7 @@ public class UnicodeSet extends UnicodeFilter {
/**
* Tests if every character in the string is in this set.
* @parameter the source string
* @param the source string
* @return true if contained
* @internal -- this API is not for general use, and may change at any time.
*/
@ -1336,7 +1336,7 @@ public class UnicodeSet extends UnicodeFilter {
/**
* Tests whether none of the characters are contained.
* @parameter the source string
* @param the source string
* @return true if the condition is met
* @internal -- this API is not for general use, and may change at any time.
*/
@ -1352,7 +1352,7 @@ public class UnicodeSet extends UnicodeFilter {
/**
* Tests whether some of the characters are contained.
* @parameter the source string
* @param the source string
* @return true if the condition is met
* @internal -- this API is not for general use, and may change at any time.
*/
@ -1363,7 +1363,7 @@ public class UnicodeSet extends UnicodeFilter {
/**
* Tests whether some of the characters are contained.
* @parameter the source string
* @param the source string
* @return true if the condition is met
* @internal -- this API is not for general use, and may change at any time.
*/
@ -1374,7 +1374,7 @@ public class UnicodeSet extends UnicodeFilter {
/**
* Tests whether some of the characters are contained.
* @parameter the source string
* @param the source string
* @return true if the condition is met
* @internal -- this API is not for general use, and may change at any time.
*/

6
icu4j/src/com/ibm/icu/text/UnicodeSetIterator.java
View File

@ -5,8 +5,8 @@
*******************************************************************************
*
* $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/text/UnicodeSetIterator.java,v $
* $Date: 2002/03/19 00:11:52 $
* $Revision: 1.7 $
* $Date: 2002/03/20 05:11:17 $
* $Revision: 1.8 $
*
*****************************************************************************************
*/
@ -35,7 +35,7 @@ public final class UnicodeSetIterator {
/**
* Create an iterator
* @set set to iterate over
* @param set set to iterate over
*/
public UnicodeSetIterator(UnicodeSet set) {
reset(set);

3
icu4j/src/com/ibm/icu/util/Calendar.java
View File

@ -644,7 +644,7 @@ import java.util.ResourceBundle;
* @see GregorianCalendar
* @see TimeZone
* @see DateFormat
* @version $Revision: 1.24 $ $Date: 2002/03/10 19:40:16 $
* @version $Revision: 1.25 $ $Date: 2002/03/20 05:11:17 $
* @author Mark Davis, David Goldsmith, Chen-Lieh Huang, Alan Liu, Laura Werner
* @since JDK1.1
*/
@ -2950,6 +2950,7 @@ public abstract class Calendar implements Serializable, Cloneable {
};
/**
* Subclass API for defining limits of different types.
* Subclasses must implement this method to return limits for the
* following fields:
*

6
icu4j/src/com/ibm/icu/util/SimpleDateRule.java
View File

@ -5,8 +5,8 @@
*******************************************************************************
*
* $Source: /xsrl/Nsvn/icu/icu4j/src/com/ibm/icu/util/SimpleDateRule.java,v $
* $Date: 2002/02/16 03:06:29 $
* $Revision: 1.6 $
* $Date: 2002/03/20 05:11:17 $
* $Revision: 1.7 $
*
*****************************************************************************************
*/
@ -35,7 +35,7 @@ public class SimpleDateRule implements DateRule
}
/**
* Construct a rule for a weekday within a month, e.g. the first Monday
* Construct a rule for a weekday within a month, e.g. the first Monday.
*
* @param month The month in which this rule occurs (0-based).
* @param dayOfMonth A date within that month (1-based).

18
icu4j/src/com/ibm/richtext/styledtext/MConstText.java
View File

@ -1,5 +1,5 @@
/*
* @(#)$RCSfile: MConstText.java,v $ $Revision: 1.2 $ $Date: 2002/02/16 03:06:35 $
* @(#)$RCSfile: MConstText.java,v $ $Revision: 1.3 $ $Date: 2002/03/20 05:11:17 $
*
* (C) Copyright IBM Corp. 1998-1999. All Rights Reserved.
*
@ -79,7 +79,7 @@ public abstract class MConstText {
/**
* Return the character at offset <code>pos</code>.
* @param pos a valid offset into the text
* @returns the character at offset <code>pos</code>
* @return the character at offset <code>pos</code>
*/
public abstract char at(int pos);
@ -143,7 +143,7 @@ public abstract class MConstText {
* Return the index of the first character in the character style run
* containing pos. All characters in a style run have the same character
* style.
* @returns the style at offset <code>pos</code>
* @return the style at offset <code>pos</code>
*/
public abstract int characterStyleStart(int pos);
@ -151,14 +151,14 @@ public abstract class MConstText {
* Return the index after the last character in the character style run
* containing pos. All characters in a style run have the same character
* style.
* @returns the style at offset <code>pos</code>
* @return the style at offset <code>pos</code>
*/
public abstract int characterStyleLimit(int pos);
/**
* Return the style applied to the character at offset <code>pos</code>.
* @param pos a valid offset into the text
* @returns the style at offset <code>pos</code>
* @return the style at offset <code>pos</code>
*/
public abstract AttributeMap characterStyleAt(int pos);
@ -168,21 +168,21 @@ public abstract class MConstText {
/**
* Return the start of the paragraph containing the character at offset <code>pos</code>.
* @param pos a valid offset into the text
* @returns the start of the paragraph containing the character at offset <code>pos</code>
* @return the start of the paragraph containing the character at offset <code>pos</code>
*/
public abstract int paragraphStart(int pos);
/**
* Return the limit of the paragraph containing the character at offset <code>pos</code>.
* @param pos a valid offset into the text
* @returns the limit of the paragraph containing the character at offset <code>pos</code>
* @return the limit of the paragraph containing the character at offset <code>pos</code>
*/
public abstract int paragraphLimit(int pos);
/**
* Return the paragraph style applied to the paragraph containing offset <code>pos</code>.
* @param pos a valid offset into the text
* @returns the paragraph style in effect at <code>pos</code>
* @return the paragraph style in effect at <code>pos</code>
*/
public abstract AttributeMap paragraphStyleAt(int pos);
@ -322,4 +322,4 @@ public abstract class MConstText {
return hashCode;
}
}
}

18
icu4j/src/com/ibm/richtext/styledtext/StyledText.java
View File

@ -1,5 +1,5 @@
/*
* @(#)$RCSfile: StyledText.java,v $ $Revision: 1.2 $ $Date: 2002/02/16 03:06:37 $
* @(#)$RCSfile: StyledText.java,v $ $Revision: 1.3 $ $Date: 2002/03/20 05:11:17 $
*
* (C) Copyright IBM Corp. 1998-1999. All Rights Reserved.
*
@ -170,7 +170,7 @@ public final class StyledText extends MText implements Externalizable
/**
* Return the character at offset <code>pos</code>.
* @param pos a valid offset into the text
* @returns the character at offset <code>pos</code>
* @return the character at offset <code>pos</code>
*/
public char at(int pos)
{
@ -236,7 +236,7 @@ public final class StyledText extends MText implements Externalizable
* Create a <code>CharacterIterator</code> over the range [<code>start</code>, <code>limit</code>).
* @param start the beginning of the iterator's range
* @param limit the limit of the iterator's range
* @returns a valid <code>CharacterIterator</code> over the specified range
* @return a valid <code>CharacterIterator</code> over the specified range
* @see java.text.CharacterIterator
*/
public CharacterIterator createCharacterIterator(int start, int limit)
@ -252,7 +252,7 @@ public final class StyledText extends MText implements Externalizable
* Return the index of the first character in the character style run
* containing pos. All characters in a style run have the same character
* style.
* @returns the style at offset <code>pos</code>
* @return the style at offset <code>pos</code>
*/
public int characterStyleStart(int pos) {
@ -264,7 +264,7 @@ public final class StyledText extends MText implements Externalizable
* Return the index after the last character in the character style run
* containing pos. All characters in a style run have the same character
* style.
* @returns the style at offset <code>pos</code>
* @return the style at offset <code>pos</code>
*/
public int characterStyleLimit(int pos) {
@ -275,7 +275,7 @@ public final class StyledText extends MText implements Externalizable
/**
* Return the style applied to the character at offset <code>pos</code>.
* @param pos a valid offset into the text
* @returns the style at offset <code>pos</code>
* @return the style at offset <code>pos</code>
*/
public AttributeMap characterStyleAt(int pos)
{
@ -289,7 +289,7 @@ public final class StyledText extends MText implements Externalizable
/**
* Return the start of the paragraph containing the character at offset <code>pos</code>.
* @param pos a valid offset into the text
* @returns the start of the paragraph containing the character at offset <code>pos</code>
* @return the start of the paragraph containing the character at offset <code>pos</code>
*/
public int paragraphStart(int pos)
{
@ -300,7 +300,7 @@ public final class StyledText extends MText implements Externalizable
/**
* Return the limit of the paragraph containing the character at offset <code>pos</code>.
* @param pos a valid offset into the text
* @returns the limit of the paragraph containing the character at offset <code>pos</code>
* @return the limit of the paragraph containing the character at offset <code>pos</code>
*/
public int paragraphLimit(int pos)
{
@ -311,7 +311,7 @@ public final class StyledText extends MText implements Externalizable
/**
* Return the paragraph style applied to the paragraph containing offset <code>pos</code>.
* @param pos a valid offset into the text
* @returns the paragraph style in effect at <code>pos</code>
* @return the paragraph style in effect at <code>pos</code>
*/
public AttributeMap paragraphStyleAt(int pos)
{

10
icu4j/src/com/ibm/richtext/textformat/MFormatter.java
View File

@ -1,5 +1,5 @@
/*
* @(#)$RCSfile: MFormatter.java,v $ $Revision: 1.3 $ $Date: 2002/02/16 03:06:43 $
* @(#)$RCSfile: MFormatter.java,v $ $Revision: 1.4 $ $Date: 2002/03/20 05:11:17 $
*
* (C) Copyright IBM Corp. 1998-1999. All Rights Reserved.
*
@ -153,7 +153,7 @@ public abstract class MFormatter {
* @param viewRect the Rectangle in which the text will be displayed. This is needed for
* returning the "damaged" area - the area of the screen in which the text must be redrawn.
* @param origin the top-left corner of the text, in the display's coordinate system
* @returns a <tt>Rectangle</tt> which specifies the area in which text must be
* @return a <tt>Rectangle</tt> which specifies the area in which text must be
* redrawn to reflect the change to the text.
*/
public abstract Rectangle updateFormat(int afStart,
@ -236,7 +236,7 @@ public abstract class MFormatter {
* @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.
* @returns a <tt>Rectangle</tt>, relative to <tt>origin</tt>, which encloses the lines containing the offsets
* @return a <tt>Rectangle</tt>, relative to <tt>origin</tt>, which encloses the lines containing the offsets
*/
public abstract Rectangle getBoundingRect(TextOffset offset1,
TextOffset offset2,
@ -254,7 +254,7 @@ public abstract class MFormatter {
* For arrow keys.
* @param previousOffset the insertion offset prior to the arrow key press
* @param direction the direction of the arrow key (eUp, eDown, eLeft, or eRight)
* @returns new offset based on direction and previous offset.
* @return new offset based on direction and previous offset.
*/
public abstract TextOffset findInsertionOffset(TextOffset result,
TextOffset previousOffset,
@ -267,7 +267,7 @@ public abstract class MFormatter {
* @param initialOffset The offset at which an up-down arrow key sequence began.
* @param previousOffset The insertion offset prior to the arrow key press.
* @param direction The direction of the arrow key (eUp, eDown, eLeft, or eRight)
* @returns new offset based on direction and previous offset(s).
* @return new offset based on direction and previous offset(s).
*/
public abstract TextOffset findNewInsertionOffset(TextOffset result,
TextOffset initialOffset,