<i18n dev> RFR: 8336039: Doccheck: HTML warnings, broken links and missing files in java.base documentation

[Daniel Jeliński]

On Fri, 19 Jul 2024 11:11:38 GMT, Nizar Benalla <nbenalla at openjdk.org> wrote:

> Can I get a review for this change that fixes some broken links in javadoc comments? The new docs are hosted [here](https://cr.openjdk.org/~nbenalla/GeneratedDocs/8336039-warnings-links/).
> 
> It's mostly fixing some relative links.
> If using `{@docroot}` isn't ideal I can change it.
> 
> Here is the result of running `diff -r docs-master docs` on the docs from master vs and after these changes 
> 
> 
> diff -r docs-master/api/java.base/java/lang/classfile/components/CodeStackTracker.html docs/api/java.base/java/lang/classfile/components/CodeStackTracker.html
> 106c106
> <  <p>
> ---
>>  </p>
> diff -r docs-master/api/java.base/java/lang/classfile/package-summary.html docs/api/java.base/java/lang/classfile/package-summary.html
> 99c99
> <  <p>
> ---
>> 
> 106c106
> <  <p>
> ---
>> 
> 618c618
> <  <p>
> ---
>> 
> 755c755
> <  <p>
> ---
>> 
> 783c783
> < <p>
> ---
>> 
> diff -r docs-master/api/java.base/java/lang/foreign/Arena.html docs/api/java.base/java/lang/foreign/Arena.html
> 142c142
> <  the segments allocated by it) becomes <a href="../../../java/lang/ref/package.html#reachability">unreachable</a>,
> ---
>>  the segments allocated by it) becomes <a href="../../../java/lang/ref/package-summary.html#reachability">unreachable</a>,
> diff -r docs-master/api/java.base/java/lang/foreign/MemorySegment.Scope.html docs/api/java.base/java/lang/foreign/MemorySegment.Scope.html
> 120c120
> <  as long as it is <a href="../../../java/lang/ref/package.html#reachability">reachable</a>.
> ---
>>  as long as it is <a href="../../../java/lang/ref/package-summary.html#reachability">reachable</a>.
> diff -r docs-master/api/java.base/java/lang/foreign/MemorySegment.html docs/api/java.base/java/lang/foreign/MemorySegment.html
> 1420c1420
> <           kept <a href="../../../java/lang/ref/package.html#reachability">reachable</a>
> ---
>>           kept <a href="../../../java/lang/ref/package-summary.html#reachability">reachable</a>
> 1833c1833
> <           <a href="../../../java/lang/ref/package.html#reachability">unreachable</a>.
> ---
>>           <a href="../../../java/lang/ref/package-summary.html#reachability">unreachable</a>.
> 1899c1899
> <           <a href="../../../java/lang/ref/package.html#reachability">unreachable</a>.
> ---
>>           <a href="../../../java/lang/ref/package-summary.html#reachability">unreachable</a>.
> diff -r docs-master/api/java.base/java/lang/foreign/SymbolLookup.html docs/api/java.base/java/lang/foreign/SymbolLookup.html
> 395c395
> <  <a href="../../../java/lang/ref/package.html#reachability">unreachable</a>. The
> ---
>>  <a href="../../../j...

src/java.base/share/classes/javax/security/auth/Subject.java line 111:

> 109:  * input type and exceptions thrown are slightly different.
> 110:  *
> 111:  * <p><b><a id="sm-allowed">These methods behave differently depending on

Suggestion:

 * <p id="sm-allowed"><b>These methods behave differently depending on

We seem to mix `<p id` and `<p><a id` in our code, so both forms should work fine, and the `<p id` form seems to be a better fit here.

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

PR Review Comment: https://git.openjdk.org/jdk/pull/20251#discussion_r1684315917