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

JEP 106: Add Javadoc to javax.tools

    XMLWordPrintable

    Details

    • Type: JEP
    • Status: Closed
    • Priority: P4
    • Resolution: Delivered
    • Fix Version/s: 8
    • Component/s: tools
    • Labels:
      None
    • Author:
      Jonathan Gibbons
    • JEP Type:
      Feature
    • Exposure:
      Open
    • Subcomponent:
    • Scope:
      SE
    • JSR:
      199 MR
    • Discussion:
      compiler dash dev at openjdk dot java dot net
    • Effort:
      S
    • Duration:
      S
    • Alert Status:
       Green
    • JEP Number:
      106

      Description

      Summary

      Extend the javax.tools API to provide access to javadoc.

      Motivation

      It is increasingly common to want to invoke tools via an API, as part of a larger software environment, instead of by exec-ing a new process. This provides improved performance by avoiding the need to start additional JVMs, and by providing an API for more type-safe invocation.

      Description

      The API changes are relatively small, but the implementation behind the new methods involves some amount of refactoring the existing implementation. The primary task is to change all existing uses of java.io.File into corresponding uses of javax.tools.FileObject. Much of this work has already been done in JDK 7, but the remaining work has had to be deferred because of a probably dependence on the new NIO API.

      Testing

      Unit (jtreg) tests will be provided to exercise the new functionality. There will not be any platform-specific requirements.

      Risks and Assumptions

      Generally speaking, javadoc is very old code, that has not had much TLC in a long time. There is a risk that the refactoring will not be as simple as expected.

      Dependences

      Up to now, there has been a probable dependence on the new NIO API, but that has now become available in JDK 7.

      Impact

      • JCP: maintenance review of JSR 199
      • Compatibility: minimal
      • Documentation: API docs only
      • Internationalization: minimal
      • Localization: minimal

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              jjg Jonathan Gibbons
              Reporter:
              jjg Jonathan Gibbons
              Owner:
              Jonathan Gibbons Jonathan Gibbons
              Endorsed By:
              Brian Goetz
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: