JDK-8215587 : Remove support for the "old" doclet API in com.sun.javadoc.*
  • Type: CSR
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Priority: P3
  • Status: Closed
  • Resolution: Approved
  • Fix Versions: 13
  • Submitted: 2018-12-19
  • Updated: 2019-02-11
  • Resolved: 2019-02-11
Related Reports
CSR :  
Description
Summary
-------

Remove support for the now-unsupported "old" doclet API

Problem
-------

The version of the javadoc "doclet" API that was in use up to JDK 8 was superseded by a new API in JDK 9, and a corresponding new "Standard Doclet". The old Standard Doclet has already been removed; the old API has been retained somewhat longer in case there are other doclets in use using the API. However, the API is old, unsupported and does not support newer language features, like modules, and newer javadoc tags.

Solution
--------

Remove the old API in com.sun.javadoc.*, and the old entry point, com.sun.tools.javadoc.Start

An off-brand use of the old API was as an early "Language Model" API. But javax.lang.model has been available as a first-class supported Language Model API since JDK 6. 


Specification
-------------

The primary change is about removing the old API. There are some residual references in the remaining API that need to be updated.

Specification attached, also available at 
 
*   <http://cr.openjdk.java.net/~pmuthuswamy/8215584/specdiff//overview-summary.html>
*   <http://cr.openjdk.java.net/~pmuthuswamy/8215584/specdiff_plain_profile/specdiff-summary.html>
    (shows changes in module declaration)
Comments
The release note will be created as part of the umbrella release note for JDK-8215608
11-02-2019

Approved conditional on a release note being created. A proactive notification to jdk-dev is advisable too.
11-02-2019