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

Daniel Jeliński djelinski at openjdk.org
Fri Jul 19 15:53:34 UTC 2024


On Fri, 19 Jul 2024 14:20:48 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
>> ...
>
> Nizar Benalla has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Update src/java.base/share/classes/java/lang/foreign/MemorySegment.java
>   
>   forgot this one
>   
>   Co-authored-by: Chen Liang <liach at openjdk.org>

Marked as reviewed by djelinski (Reviewer).

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

PR Review: https://git.openjdk.org/jdk/pull/20251#pullrequestreview-2188559747


More information about the i18n-dev mailing list