Javadoc

Javadoc is a Java API documentation generator for developers who want reference pages built from source. It is strongest when a team already works with the JDK and wants control over the generated HTML; it is a weaker fit for teams seeking an interactive, hosted API reference.

Overview

Installed with the Java Development Kit, Javadoc turns Java source into HTML documentation. The standard doclet covers public and protected types and members, while alternate doclets let teams change what the output contains and how it is formatted. That makes it a practical choice for Java projects that want documentation generated alongside their code, rather than a separate API publishing service.

Key features

The standard doclet documents classes, interfaces, constructors, methods, and fields. Inputs can be whole packages, individual Java source files, or both, with recursive inclusion of subpackages. This range supports either a focused documentation run or broader coverage of a package tree.

Alternate doclets provide control over output content and format, and taglets allow custom tags in documentation comments. Code samples are supported. Javadoc does not import OpenAPI definitions or provide an interactive API reference, so it is not the right tool when readers need to explore or try API operations in a browser.

DocLint can catch common problems in comments, but it does not establish full conformance or correct mistakes. A review and repair step remains necessary. Oracle also warns that non-conformant output or output containing executable content such as JavaScript can pose problems, so generated pages should be treated with care.

Pricing

The Javadoc tool is included with JDK 25, and the JDK 25 binaries cost nothing under Oracle's No-Fee Terms and Conditions through September 2028. The stated free terms apply to updates only through that date. Later updates use the Java SE OTN License, which may require a fee for production use beyond its limited free grants.

The entry also gives a 30-day trial and identifies a paid pricing model, but the named Javadoc plan is the included-with-JDK option. For technical questions and service requests, Oracle directs customers with active support contracts to My Oracle Support.

Platforms

Oracle lists JDK 25 downloads for Linux, macOS, and Windows. Javadoc is a self-hosted tool installed with the JDK, rather than a hosted documentation service. It also supports deployment models described as both, clustering, an admin console, and containers; supported operating systems include Linux, UNIX, and Windows.

Who it's for

Javadoc suits Java developers and teams that maintain libraries or applications and want API pages generated from source, especially when custom output or project-specific comment tags matter. Look elsewhere if the priority is interactive browsing, OpenAPI import, or a hosted reference portal; its comment checks also leave conformance and correction to the team.

Pros and cons

• Pro: It comes with the JDK, so Java teams can generate reference pages from their existing source and package structure.
• Pro: Alternate doclets and taglets allow customization of output and documentation-comment conventions.
• Con: DocLint only flags common comment problems; it does not validate conformance fully or fix errors.
• Con: There is no OpenAPI import or interactive API reference, limiting its fit for browser-based API exploration.
• Con: Free JDK 25 updates under NFTC end in September 2028, after which production-use terms may involve fees.

Alternatives

For a broader directory of documentation options, see API Documentation Tools. The listed alternatives are profiling products, not direct substitutes for generating Java API reference pages. VisualVM is a free standalone Java troubleshooting tool for Windows, Linux, and macOS, so it is the more relevant choice if Java troubleshooting, rather than documentation, is the need. Grafana Cloud Application Observability offers a freemium observability service with a free allowance of 2,232 host hours, better suited to readers seeking application monitoring. The remaining alternatives are profilers: Scalene is an open-source Python profiler; Parca is an Apache 2-licensed open-source option; py-spy is a sampling profiler for Python programs; Pyroscope offers a free tier with 50 GB ingestion per month and 14-day retention; async-profiler provides Linux and macOS binaries under Apache License 2.0; and Intel VTune Profiler permits commercial and non-commercial use with community support.

Profiling Software is the relevant category if profiling, rather than documentation generation, is the goal.

Verdict

Choose Javadoc if you maintain Java code and want source-based API pages that can be customized through doclets and taglets, with the tool already included in the JDK. Its main limitation is that comment checks are advisory and it lacks interactive and OpenAPI features; teams that need a richer API portal should choose a documentation tool built for that purpose.