Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8203500

Fix broken links to Specification in "specs" directory

    Details

    • Resolved In Build:
      b15
    • Verification:
      Not verified

      Backports

        Description

        A handful of references in the JavaDoc API to the Specification in the "specs" directory are broken. The provided URLs either not include "{@docRoot}" or include the non-existent "{@docRootParent}". All of the links should begin with "{@docRoot}/../specs/" as follows:

        diff -r a2c92332c6ba src/java.se/share/classes/module-info.java
        --- a/src/java.se/share/classes/module-info.java Mon May 21 12:49:03 2018 -0700
        +++ b/src/java.se/share/classes/module-info.java Mon May 21 13:58:08 2018 -0700
        @@ -30,9 +30,9 @@
          * <dl>
          * <dt class="simpleTagLabel" style="font-family:'DejaVu Sans', Arial, Helvetica, sans serif">Optional for the Java SE Platform:</dt>
          * <dd>
        - * <a href="../specs/jni/index.html">Java Native Interface (JNI)</a><br>
        - * <a href="../specs/jvmti.html">Java Virtual Machine Tool Interface (JVM TI)</a><br>
        - * <a href="../specs/jdwp/jdwp-spec.html">Java Debug Wire Protocol (JDWP)</a><br>
        + * <a href="{@docRoot}/../specs/jni/index.html">Java Native Interface (JNI)</a><br>
        + * <a href="{@docRoot}/../specs/jvmti.html">Java Virtual Machine Tool Interface (JVM TI)</a><br>
        + * <a href="{@docRoot}/../specs/jdwp/jdwp-spec.html">Java Debug Wire Protocol (JDWP)</a><br>
          * </dd>
          * </dl>
          *
        diff -r a2c92332c6ba src/jdk.compiler/share/classes/com/sun/source/doctree/package-info.java
        --- a/src/jdk.compiler/share/classes/com/sun/source/doctree/package-info.java Mon May 21 12:49:03 2018 -0700
        +++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/package-info.java Mon May 21 13:58:08 2018 -0700
        @@ -30,7 +30,7 @@
          * @author Jonathan Gibbons
          * @since 1.8
          *
        - * @see <a href="{@docRootParent}/specs/doc-comment-spec.html">
        + * @see <a href="{@docRoot}/../specs/doc-comment-spec.html">
          * Documentation Comment Specification for the Standard Doclet</a>
          */
         package com.sun.source.doctree;
        diff -r a2c92332c6ba src/jdk.javadoc/share/classes/jdk/javadoc/doclet/StandardDoclet.java
        --- a/src/jdk.javadoc/share/classes/jdk/javadoc/doclet/StandardDoclet.java Mon May 21 12:49:03 2018 -0700
        +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/doclet/StandardDoclet.java Mon May 21 13:58:08 2018 -0700
        @@ -36,7 +36,7 @@
          * This doclet generates HTML-formatted documentation for the specified modules,
          * packages and types.
          *
        - * @see <a href="{@docRootParent}/specs/doc-comment-spec.html">
        + * @see <a href="{@docRoot}/../specs/doc-comment-spec.html">
          * Documentation Comment Specification for the Standard Doclet</a>
          */
         public class StandardDoclet implements Doclet {
        diff -r a2c92332c6ba src/jdk.javadoc/share/classes/module-info.java
        --- a/src/jdk.javadoc/share/classes/module-info.java Mon May 21 12:49:03 2018 -0700
        +++ b/src/jdk.javadoc/share/classes/module-info.java Mon May 21 13:58:08 2018 -0700
        @@ -51,7 +51,7 @@
          * @provides javax.tools.DocumentationTool
          * @provides javax.tools.Tool
          *
        - * @see <a href="{@docRootParent}/specs/doc-comment-spec.html">
        + * @see <a href="{@docRoot}/../specs/doc-comment-spec.html">
          * Documentation Comment Specification for the Standard Doclet</a>
          *
          * @moduleGraph
        diff -r a2c92332c6ba src/jdk.jdwp.agent/share/classes/module-info.java
        --- a/src/jdk.jdwp.agent/share/classes/module-info.java Mon May 21 12:49:03 2018 -0700
        +++ b/src/jdk.jdwp.agent/share/classes/module-info.java Mon May 21 13:58:08 2018 -0700
        @@ -28,8 +28,8 @@
          *
          * @moduleGraph
          * @since 9
        - * @see <a href="../specs/jdwp/jdwp-spec.html">JDWP Specification</a>
        - * @see <a href="../specs/jdwp/jdwp-transport.html">JDWP Transport Specification</a>
        + * @see <a href="{@docRoot}/../specs/jdwp/jdwp-spec.html">JDWP Specification</a>
        + * @see <a href="{@docRoot}/../specs/jdwp/jdwp-transport.html">JDWP Transport Specification</a>
          */
         module jdk.jdwp.agent {
         }

          Attachments

            Issue Links

              Activity

                People

                • Assignee:
                  iris Iris Clark
                  Reporter:
                  iris Iris Clark
                • Votes:
                  0 Vote for this issue
                  Watchers:
                  2 Start watching this issue

                  Dates

                  • Created:
                    Updated:
                    Resolved: