Integrate changes cherry-picked for ticket #12010 into android_icu4j.
Minor JavaDoc fixes.
Change-Id: I16776daaacb1206b28e396ffb5883e9406e0b94c
diff --git a/android_icu4j/src/main/java/android/icu/text/CollationKey.java b/android_icu4j/src/main/java/android/icu/text/CollationKey.java
index a0438c0..2ada6dc 100644
--- a/android_icu4j/src/main/java/android/icu/text/CollationKey.java
+++ b/android_icu4j/src/main/java/android/icu/text/CollationKey.java
@@ -1,7 +1,7 @@
/* GENERATED SOURCE. DO NOT MODIFY. */
/**
*******************************************************************************
-* Copyright (C) 1996-2014, International Business Machines Corporation and
+* Copyright (C) 1996-2015, International Business Machines Corporation and
* others. All Rights Reserved.
*******************************************************************************
*/
@@ -24,7 +24,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.
@@ -47,7 +47,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/android_icu4j/src/main/java/android/icu/text/Collator.java b/android_icu4j/src/main/java/android/icu/text/Collator.java
index 589389d..c454012 100644
--- a/android_icu4j/src/main/java/android/icu/text/Collator.java
+++ b/android_icu4j/src/main/java/android/icu/text/Collator.java
@@ -36,7 +36,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/android_icu4j/src/main/java/android/icu/text/DateIntervalInfo.java b/android_icu4j/src/main/java/android/icu/text/DateIntervalInfo.java
index 14519cc..38f1d7f 100644
--- a/android_icu4j/src/main/java/android/icu/text/DateIntervalInfo.java
+++ b/android_icu4j/src/main/java/android/icu/text/DateIntervalInfo.java
@@ -42,7 +42,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
@@ -193,7 +193,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.
*/
public PatternInfo(String firstPart, String secondPart,
boolean firstDateInPtnIsLaterDate) {
@@ -203,28 +206,33 @@
}
/**
- * accessor
+ * Returns the first part of interval pattern.
+ * @return The first part of interval pattern.
*/
public String getFirstPart() {
return fIntervalPatternFirstPart;
}
/**
- * accessor
+ * Returns the second part of interval pattern.
+ * @return The second part of interval pattern.
*/
public String getSecondPart() {
return fIntervalPatternSecondPart;
}
/**
- * 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.
*/
public boolean firstDateInPtnIsLaterDate() {
return fFirstDateInPtnIsLaterDate;
}
/**
- * Override equals
+ * Compares the specified object with this <code>PatternInfo</code> for equality.
+ * @param a The object to be compared.
+ * @return <code>true</code> if the specified object is equal to this <code>PatternInfo</code>.
*/
public boolean equals(Object a) {
if ( a instanceof PatternInfo ) {
@@ -237,7 +245,8 @@
}
/**
- * Override hashcode
+ * Returns the hash code of this <code>PatternInfo</code>.
+ * @return A hash code value for this object.
*/
public int hashCode() {
int hash = fIntervalPatternFirstPart != null ? fIntervalPatternFirstPart.hashCode() : 0;
@@ -800,7 +809,7 @@
/**
- * Boilerplate. Clone this object.
+ * Clone this object.
* @return a copy of the object
*/
public Object clone()
@@ -858,14 +867,14 @@
/**
- * Boilerplate for Freezable
+ * {@inheritDoc}
*/
public boolean isFrozen() {
return frozen;
}
/**
- * Boilerplate for Freezable
+ * {@inheritDoc}
*/
public DateIntervalInfo freeze() {
fIntervalPatternsReadOnly = true;
@@ -874,7 +883,7 @@
}
/**
- * Boilerplate for Freezable
+ * {@inheritDoc}
*/
public DateIntervalInfo cloneAsThawed() {
DateIntervalInfo result = (DateIntervalInfo) (this.cloneUnfrozenDII());
diff --git a/android_icu4j/src/main/java/android/icu/text/DateTimePatternGenerator.java b/android_icu4j/src/main/java/android/icu/text/DateTimePatternGenerator.java
index bd17fa1..cf6e69e 100644
--- a/android_icu4j/src/main/java/android/icu/text/DateTimePatternGenerator.java
+++ b/android_icu4j/src/main/java/android/icu/text/DateTimePatternGenerator.java
@@ -1011,14 +1011,14 @@
}
/**
- * Boilerplate for Freezable
+ * {@inheritDoc}
*/
public boolean isFrozen() {
return frozen;
}
/**
- * Boilerplate for Freezable
+ * {@inheritDoc}
*/
public DateTimePatternGenerator freeze() {
frozen = true;
@@ -1026,7 +1026,7 @@
}
/**
- * Boilerplate for Freezable
+ * {@inheritDoc}
*/
public DateTimePatternGenerator cloneAsThawed() {
DateTimePatternGenerator result = (DateTimePatternGenerator) (this.clone());
@@ -1035,7 +1035,8 @@
}
/**
- * Boilerplate
+ * Returns a copy of this <code>DateTimePatternGenerator</code> object.
+ * @return A copy of this <code>DateTimePatternGenerator</code> object.
*/
@SuppressWarnings("unchecked")
public Object clone() {
