W3cubDocs
/OpenJDK 21Module jdk.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".
- Module Graph:
- Tool Guides:
- javadoc
- Since:
- 9
- External Specifications
Packages
| Package | Description |
|---|---|
| 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. |
Modules
| 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. |
Services
| 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 | Use ToolProvider.findFirst("javadoc") to obtain an instance of a ToolProvider that provides the equivalent of command-line access to the javadoc tool. |
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/jdk.javadoc/module-summary.html