The main entry points are in jdk.
which calls the (poorly-named) jdk.
which provides the overall functionality of the tool.
The classes provide a framework for processing command-line options and determining the set of elements (modules, packages, types and members) to be documented.
The classes also provide the means to use the javac front end to read source files, including the documentation comments.
Finally, once the appropriate files have been read, the classes invoke the selected doclet to process those files, typically to generate API documentation.
| Modifier and Type | Class and Description |
|---|---|
| public class | DocEnvImpl
This class holds the information from one run of javadoc. |
| public class | ElementsTable
This class manages elements specified on the command line, and produces "specified" and "included" data sets, needed by the doclet environment, as well as querying an elements' visibility or inclusion. |
| pack-priv class | IllegalOptionValue
Provides a mechanism for the javadoc tool to indicate an option decoding issue, arising from a command-line error. |
| public class | JavadocClassFinder
Javadoc uses an extended class finder that records package.html entries |
| public class | JavadocEnter
Javadoc's own enter phase does a few things above and beyond that done by javac. |
| public class | JavadocLog
Class for reporting diagnostics and other messages. |
| public class | JavadocMemberEnter
Javadoc's own memberEnter phase does a few things above and beyond that done by javac. |
| public class | JavadocTodo
Javadoc's own todo queue doesn't queue its inputs, as javadoc doesn't perform attribution of method bodies or semantic checking. |
| public class | JavadocTool
This class could be the main entry point for Javadoc when Javadoc is used as a component in a larger software system. |
| public class | JavadocToolProvider
An implementation of the |
| public class | Main
Provides external entry points (tool and programmatic) for the javadoc program. |
| pack-priv class | OptionException
Provides a general mechanism for the javadoc tool to indicate an option decoding issue. |
| public class | Start
Main program of Javadoc. |
| public class | ToolEnvironment
Holds the environment for a run of javadoc. |
| pack-priv class | ToolException
Provides a mechanism for the javadoc tool to terminate execution. |
| public class | ToolOptions
Storage and support for javadoc tool options, as distinct from the options supported by any doclet that may be in use. |
| Modifier and Type | Enum and Description |
|---|---|
| public enum | AccessLevel
The access levels. |
