Module jdk.javadoc
Package jdk.javadoc.doclet
package 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.
The
The standard doclet can be used to
generate HTML-formatted documentation. It supports user-defined
taglets, which can be used to generate customized
output for user-defined tags in documentation comments.
Note: The declarations in this package supersede those
in the older package com.sun.javadoc. For details on the
mapping of old types to new types, see the
Migration Guide.
Doclets are invoked by javadoc and this API can be used to write out program information to files. For example, the standard doclet is invoked by default, to generate HTML documentation.
The invocation is defined by the interface Doclet
-- the run interface
method, defines the entry point.
public boolean run(DocletEnvironment environment)
DocletEnvironment instance holds the
environment that the doclet will be initialized with. From this environment
all other information can be extracted, in the form of
elements. One can further use the APIs and utilities
described by Language Model API to query Elements and Types.
Terminology
- Selected
- An element is considered to be selected, if the selection controls allow it to be documented. (Note that synthetic elements are never selected.)
- Specified
- The set of elements specified by the user are considered to be specified elements. Specified elements provide the starting points for determining the included elements to be documented.
- Included
- An element is considered to be included, if it is selected and any of the following is true:
- the element is specified, or
- the element contains a specified element, or
- the element is enclosed in a specified element.
Options
Javadoc selection control can be specified with these options as follows:--show-members:valueand--show-types:valuecan be used to filter the members, with the following values:- public -- considers only public elements
- protected -- considers public and protected elements
- package -- considers public, protected and package private elements
- private -- considers all elements
--show-packages:value"exported" or "all" can be used to consider only exported packages or all packages within a module.--show-module-contents:valuecan be used to specify the level at module declarations could be documented. A value of "api" indicates API level documentation, and "all" indicates detailed documentation.
--moduledocuments the specified modules.--expand-requires:valueexpand the set of modules to be documented by including some or all of the modules dependencies. The value may be one of:- transitive -- each module specified explicitly on the command line is expanded to include the closure of its transitive dependencies
- all -- each module specified explicitly on the command line is expanded to include the closure of its transitive dependencies, and also all of its direct dependencies
packagenamescan be used to specify packages.-subpackagescan be used to recursively load packages.-excludecan be used exclude package directories.sourcefilenamescan be used to specify source file names.
Interactions with older options.
The new--show-* options provide a more detailed replacement
for the older options -public, -protected, -package, -private.
Alternatively, the older options can continue to be used as shorter
forms for combinations of the new options, as described below:
| Older option | Equivalent to these values with the new option | ||||
|---|---|---|---|---|---|
--show-members
| --show-types
| --show-packages
| --show-module-contents
| ||
-public
| public | public | exported | api | |
-protected
| protected | protected | exported | api | |
-package
| package | package | all | all | |
-private
| private | private | all | all | |
A qualified element name is one that has its package
name prepended to it, such as java.lang.String. A non-qualified
name has no package name, such as String.
Example
The following is an example doclet that displays information of a class and its members, supporting an option.// Note: imports deleted for clarity
public class Example implements Doclet {
private Reporter reporter;
private PrintWriter stdout;
@Override
public void init(Locale locale, Reporter reporter) {
reporter.print(Kind.NOTE, "Doclet using locale: " + locale);
this.reporter = reporter;
stdout = reporter.getStandardWriter();
}
public void printElement(DocTrees trees, Element e) {
DocCommentTree docCommentTree = trees.getDocCommentTree(e);
if (docCommentTree != null) {
stdout.println("Element (" + e.getKind() + ": "
+ e + ") has the following comments:");
stdout.println("Entire body: " + docCommentTree.getFullBody());
stdout.println("Block tags: " + docCommentTree.getBlockTags());
}
}
@Override
public boolean run(DocletEnvironment docEnv) {
reporter.print(Kind.NOTE, "overviewFile: " + overviewFile);
// get the DocTrees utility class to access document comments
DocTrees docTrees = docEnv.getDocTrees();
// location of an element in the same directory as overview.html
try {
Element e = ElementFilter.typesIn(docEnv.getSpecifiedElements()).iterator().next();
DocCommentTree docCommentTree
= docTrees.getDocCommentTree(e, overviewFile);
if (docCommentTree != null) {
stdout.println("Overview html: " + docCommentTree.getFullBody());
}
} catch (IOException missing) {
reporter.print(Kind.ERROR, "No overview.html found.");
}
for (TypeElement t : ElementFilter.typesIn(docEnv.getIncludedElements())) {
stdout.println(t.getKind() + ":" + t);
for (Element e : t.getEnclosedElements()) {
printElement(docTrees, e);
}
}
return true;
}
@Override
public String getName() {
return "Example";
}
private String overviewFile;
@Override
public Set<? extends Option> getSupportedOptions() {
Option[] options = {
new Option() {
private final List<String> someOption = List.of(
"--overview-file",
"-overviewfile",
"-o"
);
@Override
public int getArgumentCount() {
return 1;
}
@Override
public String getDescription() {
return "an option with aliases";
}
@Override
public Option.Kind getKind() {
return Option.Kind.STANDARD;
}
@Override
public List<String> getNames() {
return someOption;
}
@Override
public String getParameters() {
return "file";
}
@Override
public boolean process(String opt, List<String> arguments) {
overviewFile = arguments.get(0);
return true;
}
}
};
return Set.of(options);
}
@Override
public SourceVersion getSupportedSourceVersion() {
// support the latest release
return SourceVersion.latest();
}
}
This doclet can be invoked with a command line, such as:
javadoc -docletpath doclet-classes \
-doclet Example \
--overview-file overview.html \
--source-path source-location \
source-location/Example.java
Migration Guide
Many of the types in the old com.sun.javadoc API do not have equivalents in this
package. Instead, types in the javax.lang.model and com.sun.source APIs
are used instead.
The following table gives a guide to the mapping from old types to their replacements. In some cases, there is no direct equivalent.
- Since:
- 9
- See Also:
-
ClassDescriptionThe user doclet must implement this interface, as described in the package description.An encapsulation of option name, aliases, parameters and descriptions as used by the Doclet.The kind of an option.Represents the operating environment of a single invocation of the doclet.The mode specifying the level of detail of module documentation.Interface for reporting diagnostics and other messages.This doclet generates HTML-formatted documentation for the specified modules, packages and types.The interface for a custom taglet supported by doclets such as the
standard doclet.The kind of location in which a tag may be used.