RFR[S]: JDK-8211876,,Broken links in java.base files (ClassLoader.html#name)

[Jonathan Gibbons]

OK, enough with fancy; here's the email again:

Please review a small fix to a couple of classes in java.base to fix a 
number of broken links in the API documentation. In 3 places, the anchor 
ClassLoader.html#name is updated to ClassLoader.html#binary-name.

JBS: https://bugs.openjdk.java.net/browse/JDK-8211876
Webrev: http://cr.openjdk.java.net/~jjg/8211876/webrev.00/

— Jon

The patch is small enough to also include here:

--- old/src/java.base/share/classes/java/lang/Class.java 2018-10-22 
13:11:51.810081861 -0700
+++ new/src/java.base/share/classes/java/lang/Class.java 2018-10-22 
13:11:51.522081849 -0700
@@ -405,7 +405,7 @@


      /**
-     * Returns the {@code Class} with the given <a 
href="ClassLoader.html#name">
+     * Returns the {@code Class} with the given <a 
href="ClassLoader.html#binary-name">
       * binary name</a> in the given module.
       *
       * <p> This method attempts to locate, load, and link the class or 
interface.
@@ -427,7 +427,7 @@
       * loads a class in another module.
       *
       * @param  module   A module
-     * @param  name     The <a href="ClassLoader.html#name">binary name</a>
+     * @param  name     The <a 
href="ClassLoader.html#binary-name">binary name</a>
       *                  of the class
       * @return {@code Class} object of the given name defined in the 
given module;
       *         {@code null} if not found.
--- old/src/java.base/share/classes/java/lang/StackWalker.java 
2018-10-22 13:11:52.662081896 -0700
+++ new/src/java.base/share/classes/java/lang/StackWalker.java 
2018-10-22 13:11:52.306081882 -0700
@@ -100,7 +100,7 @@
       */
      public interface StackFrame {
          /**
-         * Gets the <a href="ClassLoader.html#name">binary name</a>
+         * Gets the <a href="ClassLoader.html#binary-name">binary name</a>
           * of the declaring class of the method represented by this 
stack frame.
           *
           * @return the binary name of the declaring class of the method

​


On 10/22/2018 01:26 PM, Jonathan Gibbons wrote:
> Please review a small fix to a couple of classes in java.base to fix a 
> number of broken links in the API documentation. In 3 places, the 
> anchor |ClassLoader.html#name| is updated to 
> |ClassLoader.html#binary-name|.
>
> JBS: https://bugs.openjdk.java.net/browse/JDK-8211876
> Webrev: http://cr.openjdk.java.net/~jjg/8211876/webrev.00/ 
> <http://cr.openjdk.java.net/%7Ejjg/8211876/webrev.00/>
>
> — Jon
>
> The patch is small enough to also include here:
>
> |--- old/src/java.base/share/classes/java/lang/Class.java 2018-10-22 
> 13:11:51.810081861 -0700 +++ 
> new/src/java.base/share/classes/java/lang/Class.java 2018-10-22 
> 13:11:51.522081849 -0700 @@ -405,7 +405,7 @@ /** - * Returns the 
> {@code Class} with the given <a href="ClassLoader.html#name"> + * 
> Returns the {@code Class} with the given <a 
> href="ClassLoader.html#binary-name"> * binary name</a> in the given 
> module. * * <p> This method attempts to locate, load, and link the 
> class or interface. @@ -427,7 +427,7 @@ * loads a class in another 
> module. * * @param module A module - * @param name The <a 
> href="ClassLoader.html#name">binary name</a> + * @param name The <a 
> href="ClassLoader.html#binary-name">binary name</a> * of the class * 
> @return {@code Class} object of the given name defined in the given 
> module; * {@code null} if not found. --- 
> old/src/java.base/share/classes/java/lang/StackWalker.java 2018-10-22 
> 13:11:52.662081896 -0700 +++ 
> new/src/java.base/share/classes/java/lang/StackWalker.java 2018-10-22 
> 13:11:52.306081882 -0700 @@ -100,7 +100,7 @@ */ public interface 
> StackFrame { /** - * Gets the <a href="ClassLoader.html#name">binary 
> name</a> + * Gets the <a href="ClassLoader.html#binary-name">binary 
> name</a> * of the declaring class of the method represented by this 
> stack frame. * * @return the binary name of the declaring class of the 
> method |
>
> ​