RFR: JDK-8200337: Generalize see and link tags for user-defined anchors

Jonathan Gibbons jjg at openjdk.org
Wed Oct 5 01:16:26 UTC 2022


On Thu, 22 Sep 2022 16:51:56 GMT, Hannes Wallnöfer <hannesw at openjdk.org> wrote:

>One thing that is difficult for this feature is to provide a good link label if no label is supplied in the tag. In contrast to program element names a fragment name does usually not make a good human readable name. The solution is to use the fragment name as default label text. I expect that the feature will usually be used with a user provided label.

There's cognitive dissonance here.

1. a fragment name does usually not make a good human readable name
2. the solution is to use the fragment name

At a minimum, we should give a warning, or even an error. We can use the `TagletWriterImpl.invalidTagOutput` to display something inline in the page. We should consider updating the spec to require that a label is given.

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

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


More information about the compiler-dev mailing list