[jdk19] RFR: 8289223: Canonicalize header ids in foreign API javadocs
Maurizio Cimadamore
mcimadamore at openjdk.org
Mon Jun 27 17:00:45 UTC 2022
On Mon, 27 Jun 2022 16:44:17 GMT, Jorn Vernee <jvernee at openjdk.org> wrote:
> <a href="https://urldefense.com/v3/__https://github.com/openjdk/jdk/pull/8817__;!!ACWV5N9M2RV99hQ!ONT5MC45-Ze5UV3QSWdwMZbC1ssL29-DSmCyj3V9jPWzvOLSZctEnN4Ra-zFow08wzVe_7ufpSsxCxqgx0EIUoneRO4r7w$">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.
-------------
PR: https://git.openjdk.org/jdk19/pull/75
More information about the core-libs-dev
mailing list