ICU-12010 Fixed some minor API doc issues.
authorYoshito Umaoka <y.umaoka@gmail.com>
Mon, 30 Nov 2015 17:08:04 +0000 (17:08 +0000)
committerYoshito Umaoka <y.umaoka@gmail.com>
Mon, 30 Nov 2015 17:08:04 +0000 (17:08 +0000)
X-SVN-Rev: 38097

icu4j/main/classes/collate/src/com/ibm/icu/text/CollationKey.java
icu4j/main/classes/collate/src/com/ibm/icu/text/Collator.java
icu4j/main/classes/core/src/com/ibm/icu/text/DateIntervalInfo.java
icu4j/main/classes/core/src/com/ibm/icu/text/DateTimePatternGenerator.java

index 101ac08d9b191540d10864e7c4b5881f100c287d..e58fd1f1903a2aa79f71a4cf838c3f1b84ba5564 100644 (file)
@@ -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 @@ import com.ibm.icu.impl.coll.Collation;
  * <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 @@ import com.ibm.icu.impl.coll.Collation;
  * 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>
  *
index bb42de2334b53ee51059362c821ed469862c520b..a68f980afd7ab93a2ecc9d015346a8fd686f2867 100644 (file)
@@ -35,7 +35,7 @@ import com.ibm.icu.util.VersionInfo;
 * 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
index b841b76e2c87b6e9603d49f8104e5230f2240e2d..876abd117df8d1568227ae96d60bb692e32e4621 100644 (file)
@@ -41,7 +41,7 @@ import com.ibm.icu.util.UResourceBundle;
  * <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 @@ public class DateIntervalInfo implements Cloneable, Freezable<DateIntervalInfo>,
         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 @@ public class DateIntervalInfo implements Cloneable, Freezable<DateIntervalInfo>,
         }
 
         /**
-         * 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 @@ public class DateIntervalInfo implements Cloneable, Freezable<DateIntervalInfo>,
         }
 
         /**
-         * 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 @@ public class DateIntervalInfo implements Cloneable, Freezable<DateIntervalInfo>,
         }
 
         /**
-         * 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 @@ public class DateIntervalInfo implements Cloneable, Freezable<DateIntervalInfo>,
         }
 
         /**
-         * 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 @@ public class DateIntervalInfo implements Cloneable, Freezable<DateIntervalInfo>,
         }
 
         /**
-         * 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 @@ public class DateIntervalInfo implements Cloneable, Freezable<DateIntervalInfo>,
 
 
     /**
-     * Boilerplate. Clone this object.
+     * Clone this object.
      * @return     a copy of the object
      * @stable ICU4.0
      */
@@ -873,7 +882,8 @@ public class DateIntervalInfo implements Cloneable, Freezable<DateIntervalInfo>,
 
     
     /**
-     * Boilerplate for Freezable
+     * {@inheritDoc}
+     *
      * @stable ICU 4.0
      */
     public boolean isFrozen() {
@@ -881,7 +891,8 @@ public class DateIntervalInfo implements Cloneable, Freezable<DateIntervalInfo>,
     }
     
     /**
-     * Boilerplate for Freezable
+     * {@inheritDoc}
+     *
      * @stable ICU 4.4
      */
     public DateIntervalInfo freeze() {
@@ -891,7 +902,8 @@ public class DateIntervalInfo implements Cloneable, Freezable<DateIntervalInfo>,
     }
     
     /**
-     * Boilerplate for Freezable
+     * {@inheritDoc}
+     *
      * @stable ICU 4.4
      */
     public DateIntervalInfo cloneAsThawed() {
index 67dc0562b8c354fd258240ee9f27f4861a45394f..a53a69fac5329ce046fa84b0fa844952bb164350 100644 (file)
@@ -1052,7 +1052,7 @@ public class DateTimePatternGenerator implements Freezable<DateTimePatternGenera
     }
 
     /**
-     * Boilerplate for Freezable
+     * {@inheritDoc}
      * @stable ICU 3.6
      */
     public boolean isFrozen() {
@@ -1060,7 +1060,7 @@ public class DateTimePatternGenerator implements Freezable<DateTimePatternGenera
     }
 
     /**
-     * Boilerplate for Freezable
+     * {@inheritDoc}
      * @stable ICU 4.4
      */
     public DateTimePatternGenerator freeze() {
@@ -1069,7 +1069,7 @@ public class DateTimePatternGenerator implements Freezable<DateTimePatternGenera
     }
 
     /**
-     * Boilerplate for Freezable
+     * {@inheritDoc}
      * @stable ICU 4.4
      */
     public DateTimePatternGenerator cloneAsThawed() {
@@ -1079,7 +1079,8 @@ public class DateTimePatternGenerator implements Freezable<DateTimePatternGenera
     }
 
     /**
-     * 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")