src/share/classes/java/util/TimeZone.java

rev 7727 : 8020539: Clean up doclint problems in java.util package, part 2
Summary: Clean up doclint errors and warnings in classes in java.util
Reviewed-by: darcy,chegar
Contributed-by: Brian Burkhalter <brian.burkhalter@oracle.com>

*** 116,126 ****
   * <i>Digit:</i> one of
   *         <code>0 1 2 3 4 5 6 7 8 9</code>
   * </pre></blockquote>
   * For example, TimeZone.getTimeZone("GMT-8").getID() returns "GMT-08:00".
   *
!  * <h4>Three-letter time zone IDs</h4>
   *
   * For compatibility with JDK 1.1.x, some other three-letter time zone IDs
   * (such as "PST", "CTT", "AST") are also supported. However, <strong>their
   * use is deprecated</strong> because the same abbreviation is often used
   * for multiple time zones (for example, "CST" could be U.S. "Central Standard
--- 116,126 ----
   * <i>Digit:</i> one of
   *         <code>0 1 2 3 4 5 6 7 8 9</code>
   * </pre></blockquote>
   * For example, TimeZone.getTimeZone("GMT-8").getID() returns "GMT-08:00".
   *
!  * <h3>Three-letter time zone IDs</h3>
   *
   * For compatibility with JDK 1.1.x, some other three-letter time zone IDs
   * (such as "PST", "CTT", "AST") are also supported. However, <strong>their
   * use is deprecated</strong> because the same abbreviation is often used
   * for multiple time zones (for example, "CST" could be U.S. "Central Standard
*** 302,315 ****
      /**
       * Returns a long standard time name of this {@code TimeZone} suitable for
       * presentation to the user in the default locale.
       *
       * <p>This method is equivalent to:
!      * <pre><blockquote>
       * getDisplayName(false, {@link #LONG},
       *                Locale.getDefault({@link Locale.Category#DISPLAY}))
!      * </blockquote></pre>
       *
       * @return the human-readable name of this time zone in the default locale.
       * @since 1.2
       * @see #getDisplayName(boolean, int, Locale)
       * @see Locale#getDefault(Locale.Category)
--- 302,315 ----
      /**
       * Returns a long standard time name of this {@code TimeZone} suitable for
       * presentation to the user in the default locale.
       *
       * <p>This method is equivalent to:
!      * <blockquote><pre>
       * getDisplayName(false, {@link #LONG},
       *                Locale.getDefault({@link Locale.Category#DISPLAY}))
!      * </pre></blockquote>
       *
       * @return the human-readable name of this time zone in the default locale.
       * @since 1.2
       * @see #getDisplayName(boolean, int, Locale)
       * @see Locale#getDefault(Locale.Category)
*** 323,335 ****
      /**
       * Returns a long standard time name of this {@code TimeZone} suitable for
       * presentation to the user in the specified {@code locale}.
       *
       * <p>This method is equivalent to:
!      * <pre><blockquote>
       * getDisplayName(false, {@link #LONG}, locale)
!      * </blockquote></pre>
       *
       * @param locale the locale in which to supply the display name.
       * @return the human-readable name of this time zone in the given locale.
       * @exception NullPointerException if {@code locale} is {@code null}.
       * @since 1.2
--- 323,335 ----
      /**
       * Returns a long standard time name of this {@code TimeZone} suitable for
       * presentation to the user in the specified {@code locale}.
       *
       * <p>This method is equivalent to:
!      * <blockquote><pre>
       * getDisplayName(false, {@link #LONG}, locale)
!      * </pre></blockquote>
       *
       * @param locale the locale in which to supply the display name.
       * @return the human-readable name of this time zone in the given locale.
       * @exception NullPointerException if {@code locale} is {@code null}.
       * @since 1.2
*** 345,358 ****
       * specified {@code daylight} is {@code true}, a Daylight Saving Time name
       * is returned (even if this {@code TimeZone} doesn't observe Daylight Saving
       * Time). Otherwise, a Standard Time name is returned.
       *
       * <p>This method is equivalent to:
!      * <pre><blockquote>
       * getDisplayName(daylight, style,
       *                Locale.getDefault({@link Locale.Category#DISPLAY}))
!      * </blockquote></pre>
       *
       * @param daylight {@code true} specifying a Daylight Saving Time name, or
       *                 {@code false} specifying a Standard Time name
       * @param style either {@link #LONG} or {@link #SHORT}
       * @return the human-readable name of this time zone in the default locale.
--- 345,358 ----
       * specified {@code daylight} is {@code true}, a Daylight Saving Time name
       * is returned (even if this {@code TimeZone} doesn't observe Daylight Saving
       * Time). Otherwise, a Standard Time name is returned.
       *
       * <p>This method is equivalent to:
!      * <blockquote><pre>
       * getDisplayName(daylight, style,
       *                Locale.getDefault({@link Locale.Category#DISPLAY}))
!      * </pre></blockquote>
       *
       * @param daylight {@code true} specifying a Daylight Saving Time name, or
       *                 {@code false} specifying a Standard Time name
       * @param style either {@link #LONG} or {@link #SHORT}
       * @return the human-readable name of this time zone in the default locale.