RFR: 8301302: Platform preferences API [v5]

Kevin Rushforth kcr at openjdk.org
Tue Sep 5 21:10:07 UTC 2023


On Tue, 5 Sep 2023 20:44:19 GMT, Andy Goryachev <angorya at openjdk.org> wrote:

>> I think there is no need to make this a link, since the return type of the method already provides the link.
>
> not in Eclipse.  {@code} shows up in monospace font, while {@link} provides the link:
> 
> <img width="576" alt="Screenshot 2023-09-05 at 13 45 41" src="https://github.com/openjdk/jfx/assets/107069028/e7e39445-226a-48b2-8154-429e66683243">

Yes, I know that `{@code}` shows up in monospace font, while `{@link}` provides the link. It does that in the javadoc-generated API docs, too.

What I meant by my comment is that since the method in question returns a `Preferences` object, it already generates a link to that class when listing the signature the method. Our usual practice is to not include a link to a class that is returned by a method or passed in as a parameter to a method, since it is a redundant link.

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

PR Review Comment: https://git.openjdk.org/jfx/pull/1014#discussion_r1316406896


More information about the openjfx-dev mailing list