JDK-8202614 : Add ability to validate links in JavadocTester
  • Type: Enhancement
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 11
  • Priority: P3
  • Status: Resolved
  • Resolution: Fixed
  • Submitted: 2018-05-03
  • Updated: 2018-05-21
  • Resolved: 2018-05-15
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 11
11 b14Fixed
Related Reports
Relates :  
Relates :  
Relates :  
Relates :  
Relates :  
Relates :  
Relates :  
Description
The ability to navigate via links within API documentation generated by thye standard doclet is one of the key features of the documentation, but it is also one of the least tested. Such tests that exist simply test specific instances as a side-effect of checking the fragments of generated text are as expected.

In addition, we seem to have a ongoing trickle of bugs related to broken links that are discovered in the context of large doc bundles like the JDK API documentation.

We should add an ability to the JavadocTester framework to check all links within a set of files. And, this feature should be on-by-default, although it should also be possible to opt-out when absolutely necessary.

Comments
URL: http://hg.openjdk.java.net/jdk/jdk/rev/919c36db208c User: jjg Date: 2018-05-15 21:42:01 +0000
15-05-2018

Although they are different root causes, the following three, JDK-8202617, JDK-8202624, JDK-8202627, are similar, They are all about javadoc generating references to items that will not be documented, whether they are private members, enum constructors, or deprecated methods when -nodeprecated is in effect. It may be there is a common style of solution, by updating the code that determines whether a link should be generated or not. Likewise, JDK-8202622, JDK-8202626 go together, because they are all about URI encoding issues.
04-05-2018