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

[Jorn Vernee]

On Mon, 27 Jun 2022 16:57:10 GMT, Maurizio Cimadamore <mcimadamore at openjdk.org> wrote:

>> <a href="https://urldefense.com/v3/__https://github.com/openjdk/jdk/pull/8817__;!!ACWV5N9M2RV99hQ!Ooc0KcgMe7NsDGNiGbF-wfC_tK6POSNyLNDIHsrms0gVVdXsgnVAAbWZpHXSYWbAAmkJrTeqEh4N1h-1f8ZwKplq$">https://github.com/openjdk/jdk/pull/8817</a> added a button to copy a link to a section of javadoc to the clipboard.
>> 
>> This cleanup PR canonicalizes all header ids in the java.lang.foreign package to the preferred (non-legacy) style, and adds ids in places where they are missing as well.
>> 
>> In accordance with the Late-Enhancement Request Process [1], this is a `noreg-doc` documentation only change, which does not require an enhancement request.
>> 
>> [1]: https://openjdk.org/jeps/3#Late-Enhancement-Request-Process
>
> 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.

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

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