On Tue, 5 Sep 2023 21:12:09 GMT, Andy Goryachev <ango...@openjdk.org> wrote:
>> 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.
>
> All I actually want is a link to the platform keys, not to the Properties
> class per se.
> Perhaps something similar to what String.format() does.
Hmm, maybe. In that case, the description seems the best place for that sort of
link, rather than the `@return`. Although, since that list is a predominant
part of the class docs of Preferences, the link in the method signature that
already goes to Preferences class ought to cover that, I would think. I
wouldn't mind either way.
-------------
PR Review Comment: https://git.openjdk.org/jfx/pull/1014#discussion_r1316430567
