RFR: JDK-8178037 Move information from jdi-overview.html into jdk.jdi module-info.java

David Holmes david.holmes at oracle.com
Thu Apr 20 02:21:21 UTC 2017


On 19/04/2017 10:54 PM, Magnus Ihse Bursie wrote:
> With JDK-8172312, the file src/jdk.jdi/share/classes/jdi-overview.html
> is no longer included in the generated documentation. The information
> provided by that file should move to
> src/jdk.jdi/share/classes/module-info.java instead.

Looks good, but highlighted an error with the existing text:

   /**
    * Defines the Java Debugger Interface.
+  * <p>
+  * The Java™ Debug Interface (JDI) is a high level Java API 
providing

The first line should read "Debug" not "Debugger".

Contrary to what Alan suggested (sorry Alan!) I think plain "JDI" should 
be replaced by "The JDI".

Thanks,
David

> I also took the liberty of removing a bunch of other overview.html files
> that are not included in the Javadoc anymore. They provided no real
> informational value, and what text they contained is already expressed
> similarly or better in the corresponding module-info.java files instead.
>
> Bug: https://bugs.openjdk.java.net/browse/JDK-8178037
> WebRev:
> http://cr.openjdk.java.net/~ihse/JDK-8178037-fix-obsolete-overview-files/webrev.01
>
>
> /Magnus
>



More information about the build-dev mailing list