<i18n dev> RFR: 8300589: Use @snippet and @linkplain in java.text.CollationKey and java.text.CompactNumberFormat

[Naoto Sato]

On Thu, 19 Jan 2023 22:25:51 GMT, Justin Lu <jlu at openjdk.org> wrote:

> This PR implements _JEP 413: Code Snippets in Java API Documentation_ for [java.text.CollationKey](https://docs.oracle.com/en/java/javase/19/docs/api/java.base/java/text/CollationKey.html) and [java.text.CompactNumberFormat](https://docs.oracle.com/en/java/javase/19/docs/api/java.base/java/text/CompactNumberFormat.html).
> 
> Code examples using <pre> ... </pre> blocks are replaced with the @ snippet syntax where applicable.
> 
> Additionally, for [java.text.CompactNumberFormat](https://docs.oracle.com/en/java/javase/19/docs/api/java.base/java/text/CompactNumberFormat.html) internal plain text links using <a> ... </a> are replaced with @ linkplain. (External links are kept the same)

Looks good. Minor suggestions follow.

src/java.base/share/classes/java/text/CompactNumberFormat.java line 387:

> 385:      * @param symbols the set of symbols to be used
> 386:      * @param compactPatterns an array of
> 387:      *        {@linkplain CompactNumberFormat##compact_number_patterns

Can eliminate `CompactNumberFormat` here.

src/java.base/share/classes/java/text/CompactNumberFormat.java line 415:

> 413:      * @param symbols the set of symbols to be used
> 414:      * @param compactPatterns an array of
> 415:      *        {@linkplain CompactNumberFormat##compact_number_patterns

Same as above.

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

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