Module jdk.javadoc

Defines the implementation of the system documentation tool and its command line equivalent, javadoc.

javadoc

This module provides the equivalent of command-line access to javadoc via the ToolProvider and Tool service provider interfaces (SPIs), and more flexible access via the DocumentationTool SPI.

Instances of the tools can be obtained by calling ToolProvider.findFirst or the service loader with the name "javadoc".

Tool Guides:

javadoc

Module Graph:

Since:

9

See Also:

Documentation Comment Specification for the Standard Doclet

Packages

Exports

Package	Description
com.sun.javadoc	Note: The declarations in this package have been superseded by those in the package jdk.javadoc.doclet.
com.sun.tools.doclets	Note: The declarations in this package have been superseded by those in the new package jdk.javadoc.doclet.
com.sun.tools.doclets.standard	Note: The declarations in this package have been superseded by those in the new package jdk.javadoc.doclet.
com.sun.tools.javadoc	This package and its contents are deprecated and may be removed in a future release.
jdk.javadoc.doclet	The Doclet API provides an environment which, in conjunction with the Language Model API and Compiler Tree API, allows clients to inspect the source-level structures of programs and libraries, including API comments embedded in the source.

Indirect Exports

From	Packages
java.compiler	javax.annotation.processing javax.lang.model javax.lang.model.element javax.lang.model.type javax.lang.model.util javax.tools
jdk.compiler	com.sun.source.doctree com.sun.source.tree com.sun.source.util com.sun.tools.javac

Modules

Requires

Modifier	Module	Description
transitive	java.compiler	Defines the Language Model, Annotation Processing, and Java Compiler APIs.
transitive	jdk.compiler	Defines the implementation of the system Java compiler and its command line equivalent, javac, as well as javah.

Services

Provides

Type	Description
DocumentationTool	Interface to invoke Java™ programming language documentation tools from programs.
Tool	Common interface for tools that can be invoked from a program.
ToolProvider	An interface for command-line tools to provide a way to be invoked without necessarily starting a new VM.