RFR: 8300011: Refactor code examples to use @snippet in java.util.TimeZone

Naoto Sato naoto at openjdk.org
Thu Jan 12 21:11:15 UTC 2023


On Wed, 11 Jan 2023 23:41:46 GMT, Justin Lu <duke at openjdk.org> wrote:

> This PR implements JEP 413: Code Snippets in Java API Documentation for _[java.util.TimeZone](https://docs.oracle.com/en/java/javase/19/docs/api/java.base/java/util/TimeZone.html)_.
> 
> Code examples using <pre> ...  </pre> blocks are replaced with the @ snippet syntax where applicable.

src/java.base/share/classes/java/util/TimeZone.java line 313:

> 311:      * <p>This method is equivalent to:
> 312:      * {@snippet lang=java :
> 313:      * getDisplayName(false, LONG, // @link substring="LONG" target="#LONG"

You could move those `@link` directives above the code and concatenate them with ":", e.g,

    * // @link substring="LONG" target="#LONG" :
    * getDisplayName(false, LONG,

so that the line won't be very long.

-------------

PR: https://git.openjdk.org/jdk/pull/11955


More information about the core-libs-dev mailing list