Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8202614

Add ability to validate links in JavadocTester

    XMLWordPrintable

    Details

    • Type: Enhancement
    • Status: Resolved
    • Priority: P3
    • Resolution: Fixed
    • Affects Version/s: 11
    • Fix Version/s: 11
    • Component/s: tools
    • Labels:

      Backports

        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.

          Attachments

            Issue Links

              Activity

                People

                Assignee:
                jjg Jonathan Gibbons
                Reporter:
                jjg Jonathan Gibbons
                Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                  Dates

                  Created:
                  Updated:
                  Resolved: