RFR: JDK-8247784,Bad link causes invalid documentation

Jonathan Gibbons jonathan.gibbons at oracle.com
Fri Jun 19 03:16:01 UTC 2020


resend, with correct subject line

On 6/18/20 8:12 PM, Jonathan Gibbons wrote:
>
> Please review some changes to fix typos in some recent doc updates.
>
> In two places, ${docRoot} is used instead of {@docRoot}
>
> -- Jon
>
> JBS: https://bugs.openjdk.java.net/browse/JDK-8247784
>
> 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()
>       */
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mail.openjdk.java.net/pipermail/serviceability-dev/attachments/20200618/8008aebb/attachment-0001.htm>


More information about the serviceability-dev mailing list