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

Nizar Benalla nbenalla at openjdk.org
Fri Jul 19 11:47:43 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="../../../java/lang/ref/package-summary.html#reachability">unreachable</a>. The
diff -r docs-master/api/java.base/java/net/spi/InetAddressResolver.LookupPolicy.html docs/api/java.base/java/net/spi/InetAddressResolver.LookupPolicy.html
117c117
<  <a href="doc-files/net-properties.html#Ipv4IPv6">System Properties</a> which affect
---
>  <a href="../doc-files/net-properties.html#Ipv4IPv6">System Properties</a> which affect
diff -r docs-master/api/java.base/java/text/MessageFormat.html docs/api/java.base/java/text/MessageFormat.html
433,434c433
< 
<  <p>
---
>  </p>
diff -r docs-master/api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html docs/api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html
245c245
<  <a href="#TreeStructure">Tree Structure</a> section in the class description
---
>  <a href="../../../../java.base/java/util/concurrent/StructuredTaskScope.html#TreeStructure">Tree Structure</a> section in the class description
diff -r docs-master/api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html docs/api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html
242c242
<  <a href="#TreeStructure">Tree Structure</a> section in the class description
---
>  <a href="../../../../java.base/java/util/concurrent/StructuredTaskScope.html#TreeStructure">Tree Structure</a> section in the class description
diff -r docs-master/api/java.base/javax/security/auth/Subject.html docs/api/java.base/javax/security/auth/Subject.html
207,208c207,208
<  whether a security manager is
<  <a href="../../../java/lang/SecurityManager.html#set-security-manager">allowed or disallowed</a></a></b>:
---
>  whether a security manager is</a>
>  <a href="../../../java/lang/SecurityManager.html#set-security-manager">allowed or disallowed</a></b>:

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

Commit messages:
 - (C)
 - Merge remote-tracking branch 'upstream/master' into fix-broken-links-java-base
 - remove html warnings, broken links

Changes: https://git.openjdk.org/jdk/pull/20251/files
  Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=20251&range=00
  Issue: https://bugs.openjdk.org/browse/JDK-8336039
  Stats: 23 lines in 9 files changed: 0 ins; 1 del; 22 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