JDK-8164408 : Add module support for @see, @link and @linkplain javadoc tags.
  • Type: Enhancement
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 9
  • Priority: P3
  • Status: Resolved
  • Resolution: Fixed
  • Submitted: 2016-08-18
  • Updated: 2024-10-17
  • Resolved: 2020-06-09
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.
JDK 15 JDK 16
15 b27Fixed 16Fixed
Related Reports
Blocks :  
JDK-8189591 - No way to locally suppress doclint warnings
CSR :  
JDK-8191355 - Add module support for @see, @link and @linkplain javadoc tags.
Relates :  
JDK-8280488 - doclint reference checks withstand warning suppression
Relates :  
JDK-8203494 - Improve javadoc tag specification.
Relates :  
JDK-8280492 - Use cross-module syntax for cross-module links
Description
The javadoc tags @see, @link and @linkplain, used to insert link with visible text label or just plain labels, should support modules.
Comments
URL: https://hg.openjdk.java.net/jdk/jdk/rev/aff89df892b7 User: hannesw Date: 2020-06-09 16:18:56 +0000
09-06-2020
While references to packages, types and members in other modules can be done in the impl of ReferenceTree, the ability to specifically link to modules will probably need changes in the link factory.
21-05-2018
We have to retain compatibility with all existing uses of these references. That implies that mostly we should allow an extended syntax, with a prefix of "module-name/" when a package name is present. In addition, maybe we should allow "module-name" by itself (if there is no like-named package) or "module-name/" to explicitly name a module.
21-05-2018
The DocTree nodes need to be updated.
17-08-2017
Part of the issue here is related to the JLS section, "the meaning of a name". In a Java program, module names occur in distinct well defined places, and so we don't need JLS to resolve ambiguities. But in javadoc reference tags, a name could be a package name or a module name, and we have to decide which we consider we want to choose in the disambiguation.
24-08-2016
This may effectively be an enhancement for com.sun.source.tree.ReferenceTree which is the underpinnings of the DocTree nodes for @see, @link, etc
19-08-2016