<i18n dev> RFR: 8303275: Use {@Return and @linkplain in Locale and related classes

[Justin Lu]

On Tue, 28 Feb 2023 00:09:45 GMT, Justin Lu <jlu at openjdk.org> wrote:

> This PR modifies the javadoc of methods in Locale, LocaleServiceProvider, and LocaleServiceProviderPool to use {@return and @linkplain.

src/java.base/share/classes/java/util/Locale.java line 1200:

> 1198: 
> 1199:     /**
> 1200:      * {@return an array of installed locales}

Same as above, differs with "all"

src/java.base/share/classes/java/util/Locale.java line 1239:

> 1237: 
> 1238:     /**
> 1239:      * {@return a {@code Set} of ISO3166 country codes for the specified type}

This and other instances will have the Returns ... and @return ... differ by a single word. Such as

_Returns a {@code Set} of ISO3166 country..._ 
vs 
_ at return a {@code Set} of ISO country..._

{@return is used when the Returns ... and @return ... are identical. 

I want to double check that using {@return for these instances is acceptable (even though they are technically not identical), if not I can revert them.

src/java.base/share/classes/sun/util/locale/provider/LocaleServiceProviderPool.java line 151:

> 149: 
> 150:     /**
> 151:      * {@return an array of the available locales for all the provider classes}

Same as above, differs with "the"

src/java.base/share/classes/sun/util/locale/provider/LocaleServiceProviderPool.java line 161:

> 159: 
> 160:     /**
> 161:      * {@return an array of the available locales}

Same as above, differs with "the"

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

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