[jdk19] RFR: 8289223: Canonicalize header ids in foreign API javadocs

[Maurizio Cimadamore]

On Mon, 27 Jun 2022 17:02:11 GMT, Jorn Vernee <jvernee at openjdk.org> wrote:

>> src/java.base/share/classes/java/lang/foreign/package-info.java line 30:
>> 
>>> 28:  * <p>Provides low-level access to memory and functions outside the Java runtime.
>>> 29:  *
>>> 30:  * <h2 id="fma">Foreign memory access</h2>
>> 
>> I would refrain from adding `id` if the section is never referred to.
>
> The idea is that a user might want to link to this section of the javadoc (using the new copy button). For that to be possible, the section needs an `id`. That's why I've added one to all headers. i.e. it's not just for referencing it from the javadoc in other places.

I see what you mean - at the same time I don't see being done anywhere else in JDK, so perhaps can wait until we settle on a more uniform solution?

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

PR: https://git.openjdk.org/jdk19/pull/75