Cherry-pick: ticket:12010: Fixed some minor API doc issues.
http://bugs.icu-project.org/trac/changeset/38097
Change-Id: I31c7caf4792298486b5bc4216c99b7d2d2e830e9
diff --git a/icu4j/main/classes/collate/src/com/ibm/icu/text/CollationKey.java b/icu4j/main/classes/collate/src/com/ibm/icu/text/CollationKey.java
index 101ac08..e58fd1f 100644
--- a/icu4j/main/classes/collate/src/com/ibm/icu/text/CollationKey.java
+++ b/icu4j/main/classes/collate/src/com/ibm/icu/text/CollationKey.java
@@ -1,6 +1,6 @@
/**
*******************************************************************************
-* Copyright (C) 1996-2014, International Business Machines Corporation and
+* Copyright (C) 1996-2015, International Business Machines Corporation and
* others. All Rights Reserved.
*******************************************************************************
*/
@@ -23,7 +23,7 @@
* <p>Both the method
* <code>CollationKey.compareTo(CollationKey)</code> and the method
* <code>Collator.compare(String, String)</code> compare two strings
- * and returns their relative order. The performance characterictics
+ * and returns their relative order. The performance characteristics
* of these two approaches can differ.
* Note that collation keys are often less efficient than simply doing comparison.
* For more details, see the ICU User Guide.
@@ -46,7 +46,7 @@
* compared only once.</p>
*
* <p>More information about the composition of the bit sequence can
- * be found in the
+ * be found in the
* <a href="http://www.icu-project.org/userguide/Collate_ServiceArchitecture.html">
* user guide</a>.</p>
*
diff --git a/icu4j/main/classes/collate/src/com/ibm/icu/text/Collator.java b/icu4j/main/classes/collate/src/com/ibm/icu/text/Collator.java
index bb42de2..a68f980 100644
--- a/icu4j/main/classes/collate/src/com/ibm/icu/text/Collator.java
+++ b/icu4j/main/classes/collate/src/com/ibm/icu/text/Collator.java
@@ -35,7 +35,7 @@
* subclass, RuleBasedCollator, allows customization of the collation
* ordering by the use of rule sets.</p>
*
-* <p>A Collator is thread-safe only when frozen. See {{@link #isFrozen()} and {@link Freezable}.
+* <p>A Collator is thread-safe only when frozen. See {@link #isFrozen()} and {@link Freezable}.
*
* <p>Following the <a href=http://www.unicode.org>Unicode
* Consortium</a>'s specifications for the
diff --git a/icu4j/main/classes/core/src/com/ibm/icu/text/DateIntervalInfo.java b/icu4j/main/classes/core/src/com/ibm/icu/text/DateIntervalInfo.java
index b841b76..876abd1 100644
--- a/icu4j/main/classes/core/src/com/ibm/icu/text/DateIntervalInfo.java
+++ b/icu4j/main/classes/core/src/com/ibm/icu/text/DateIntervalInfo.java
@@ -41,7 +41,7 @@
* <P>
* For power users, who want to create their own date interval patterns,
* or want to re-set date interval patterns, they could do so by
- * directly creating DateIntervalInfo and manupulating it.
+ * directly creating DateIntervalInfo and manipulating it.
*
* <P>
* Logically, the interval patterns are mappings
@@ -195,7 +195,10 @@
private final boolean fFirstDateInPtnIsLaterDate;
/**
- * constructor
+ * Constructs a <code>PatternInfo</code> object.
+ * @param firstPart The first part of interval pattern.
+ * @param secondPart The second part of interval pattern.
+ * @param firstDateInPtnIsLaterDate Whether the first date in interval patter is later date or not.
* @stable ICU 4.0
*/
public PatternInfo(String firstPart, String secondPart,
@@ -206,7 +209,8 @@
}
/**
- * accessor
+ * Returns the first part of interval pattern.
+ * @return The first part of interval pattern.
* @stable ICU 4.0
*/
public String getFirstPart() {
@@ -214,7 +218,8 @@
}
/**
- * accessor
+ * Returns the second part of interval pattern.
+ * @return The second part of interval pattern.
* @stable ICU 4.0
*/
public String getSecondPart() {
@@ -222,7 +227,8 @@
}
/**
- * accessor
+ * Returns whether the first date in interval patter is later date or not.
+ * @return Whether the first date in interval patter is later date or not.
* @stable ICU 4.0
*/
public boolean firstDateInPtnIsLaterDate() {
@@ -230,7 +236,9 @@
}
/**
- * Override equals
+ * Compares the specified object with this <code>PatternInfo</code> for equality.
+ * @param a The object to be compared.
+ * @returns <code>true</code> if the specified object is equal to this <code>PatternInfo</code>.
* @stable ICU 4.0
*/
public boolean equals(Object a) {
@@ -244,7 +252,8 @@
}
/**
- * Override hashcode
+ * Returns the hash code of this <code>PatternInfo</code>.
+ * @return A hash code value for this object.
* @stable ICU 4.0
*/
public int hashCode() {
@@ -814,7 +823,7 @@
/**
- * Boilerplate. Clone this object.
+ * Clone this object.
* @return a copy of the object
* @stable ICU4.0
*/
@@ -873,7 +882,8 @@
/**
- * Boilerplate for Freezable
+ * {@inheritDoc}
+ *
* @stable ICU 4.0
*/
public boolean isFrozen() {
@@ -881,7 +891,8 @@
}
/**
- * Boilerplate for Freezable
+ * {@inheritDoc}
+ *
* @stable ICU 4.4
*/
public DateIntervalInfo freeze() {
@@ -891,7 +902,8 @@
}
/**
- * Boilerplate for Freezable
+ * {@inheritDoc}
+ *
* @stable ICU 4.4
*/
public DateIntervalInfo cloneAsThawed() {
diff --git a/icu4j/main/classes/core/src/com/ibm/icu/text/DateTimePatternGenerator.java b/icu4j/main/classes/core/src/com/ibm/icu/text/DateTimePatternGenerator.java
index 67dc056..a53a69f 100644
--- a/icu4j/main/classes/core/src/com/ibm/icu/text/DateTimePatternGenerator.java
+++ b/icu4j/main/classes/core/src/com/ibm/icu/text/DateTimePatternGenerator.java
@@ -1052,7 +1052,7 @@
}
/**
- * Boilerplate for Freezable
+ * {@inheritDoc}
* @stable ICU 3.6
*/
public boolean isFrozen() {
@@ -1060,7 +1060,7 @@
}
/**
- * Boilerplate for Freezable
+ * {@inheritDoc}
* @stable ICU 4.4
*/
public DateTimePatternGenerator freeze() {
@@ -1069,7 +1069,7 @@
}
/**
- * Boilerplate for Freezable
+ * {@inheritDoc}
* @stable ICU 4.4
*/
public DateTimePatternGenerator cloneAsThawed() {
@@ -1079,7 +1079,8 @@
}
/**
- * Boilerplate
+ * Returns a copy of this <code>DateTimePatternGenerator</code> object.
+ * @return A copy of this <code>DateTimePatternGenerator</code> object.
* @stable ICU 3.6
*/
@SuppressWarnings("unchecked")
