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

Improve documentation for javadoc.tester.JavadocTester

    Details

    • Type: Bug
    • Status: Resolved
    • Priority: P5
    • Resolution: Fixed
    • Affects Version/s: 15
    • Fix Version/s: 16
    • Component/s: tools

      Description

      The javadoc.tester.JavadocTester framework should specify its model clearly.

      For example. It's not obvious that a subtest needs to be registered [JavadocTester.checking(...)] before it can be failed [JavadocTester.failed(...)]. Or that after a test has been registered it must call JavadocTester.passed(...) to succeed; not calling failed(...) won't have the same effect.

      Also, consider specifying what happens when "passed" and/or "failed" are called multiple times within the context of a single subtest.

        Attachments

          Activity

            People

            • Assignee:
              jjg Jonathan Gibbons
              Reporter:
              prappo Pavel Rappo
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: