JDK-8247784 : Bad link causes invalid documentation
  • Type: Bug
  • Component: core-svc
  • Sub-Component: debugger
  • Affected Version: 15
  • Priority: P3
  • Status: Resolved
  • Resolution: Fixed
  • Submitted: 2020-06-17
  • Updated: 2024-10-17
  • Resolved: 2020-06-19
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.
JDK 15 JDK 16
15 b29Fixed 16Fixed
Related Reports
Relates :  
Description
As described in these error messages, the doc comments contain invalid links.

open/src//jdk.jdi/share/classes/com/sun/jdi/Type.java:     * <a href="${docRoot}/java.base/java/lang/ClassLoader.html#binary-name">binary name</a>.
open/src//jdk.jdi/share/classes/com/sun/jdi/event/ClassUnloadEvent.java:     * <a href="${docRoot}/java.base/java/lang/ClassLoader.html#binary-name">binary name</a>.


Almost certainly, '${docRoot}' should be '{@docRoot}'.

Comments
Seems to be introduced by JDK-8238358 in 15.
08-09-2020

Changeset: e0a7782a Author: Jonathan Gibbons <jjg@openjdk.org> Date: 2020-06-19 11:10:31 +0000 URL: https://git.openjdk.java.net/lanai/commit/e0a7782a
02-07-2020

Changeset: e0a7782a Author: Jonathan Gibbons <jjg@openjdk.org> Date: 2020-06-19 11:10:31 +0000 URL: https://git.openjdk.java.net/panama-foreign/commit/e0a7782a
02-07-2020

Changeset: e0a7782a Author: Jonathan Gibbons <jjg@openjdk.org> Date: 2020-06-19 11:10:31 +0000 URL: https://git.openjdk.java.net/amber/commit/e0a7782a
02-07-2020

Changeset: e0a7782a Author: Jonathan Gibbons <jjg@openjdk.org> Date: 2020-06-19 11:10:31 +0000 URL: https://git.openjdk.java.net/mobile/commit/e0a7782a
02-07-2020

URL: https://hg.openjdk.java.net/jdk/jdk15/rev/ddac24254364 User: jjg Date: 2020-06-19 18:11:07 +0000
19-06-2020

patch: diff -r c5904de55565 src/jdk.jdi/share/classes/com/sun/jdi/Type.java --- a/src/jdk.jdi/share/classes/com/sun/jdi/Type.java Thu Jun 18 17:32:57 2020 -0700 +++ b/src/jdk.jdi/share/classes/com/sun/jdi/Type.java Thu Jun 18 20:05:42 2020 -0700 @@ -152,7 +152,7 @@ * Returns the name of this type. The result is of the same form as * the name returned by {@link Class#getName()}. * The returned name may not be a - * <a href="${docRoot}/java.base/java/lang/ClassLoader.html#binary-name">binary name</a>. + * <a href="{@docRoot}/java.base/java/lang/ClassLoader.html#binary-name">binary name</a>. * * @return the name of this type */ diff -r c5904de55565 src/jdk.jdi/share/classes/com/sun/jdi/event/ClassUnloadEvent.java --- a/src/jdk.jdi/share/classes/com/sun/jdi/event/ClassUnloadEvent.java Thu Jun 18 17:32:57 2020 -0700 +++ b/src/jdk.jdi/share/classes/com/sun/jdi/event/ClassUnloadEvent.java Thu Jun 18 20:05:42 2020 -0700 @@ -44,7 +44,7 @@ /** * Returns the {@linkplain com.sun.jdi.Type#name() name of the class} * that has been unloaded. The returned string may not be a - * <a href="${docRoot}/java.base/java/lang/ClassLoader.html#binary-name">binary name</a>. + * <a href="{@docRoot}/java.base/java/lang/ClassLoader.html#binary-name">binary name</a>. * * @see Class#getName() */
19-06-2020