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

Nizar Benalla nbenalla at openjdk.org
Fri Jul 19 14:05:07 UTC 2024


> 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...

Nizar Benalla has updated the pull request incrementally with one additional commit since the last revision:

  use @linkplain instead of href

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

Changes:
  - all: https://git.openjdk.org/jdk/pull/20251/files
  - new: https://git.openjdk.org/jdk/pull/20251/files/31649c74..c4e46f91

Webrevs:
 - full: https://webrevs.openjdk.org/?repo=jdk&pr=20251&range=02
 - incr: https://webrevs.openjdk.org/?repo=jdk&pr=20251&range=01-02

  Stats: 9 lines in 6 files changed: 0 ins; 0 del; 9 mod
  Patch: https://git.openjdk.org/jdk/pull/20251.diff
  Fetch: git fetch https://git.openjdk.org/jdk.git pull/20251/head:pull/20251

PR: https://git.openjdk.org/jdk/pull/20251


More information about the i18n-dev mailing list