Loading...

XML

Word

Printable

Type: Enhancement
Resolution: Fixed
Priority: P3
Fix Version/s: 11
Affects Version/s: 11
Component/s: tools
Labels:
- noreg-self

Subcomponent:
javadoc(tool)
Resolved In Build:
b14

Issue	Fix Version	Assignee	Priority	Status	Resolution	Resolved In Build
JDK-8203554	11.0.1	Jonathan Gibbons	P3	Resolved	Fixed	team

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.

backported by

JDK-8203554 Add ability to validate links in JavadocTester

Resolved

relates to

JDK-8202617 javadoc generates broken links to undocumented (e.g. private) members

Open

JDK-8202626 javadoc generates broken links to <Unnamed>

Resolved

JDK-8202621 bad test with broken links needs to be updated

Resolved

JDK-8202628 javadoc generates bad links in TestModules.java

Resolved

JDK-8202622 javadoc creates broken link caused by unencoded name

Closed

JDK-8202624 javadoc generates references to enum constructors, which are not documented

Closed

JDK-8202627 javadoc generates broken links to deprecated items when -nodeprecated is used

Closed

(3 relates to)

Assignee:: Jonathan Gibbons

Reporter:: Jonathan Gibbons

Votes:: 0 Vote for this issue

Watchers:: 1 Start watching this issue

Created:: 2018-05-03 12:45

Updated:: 2018-05-21 16:20

Resolved:: 2018-05-15 14:45

Details

Backports

Description

Attachments

Issue Links

Activity

People

Dates