Javadoc

Overview

Javadoc turns Java source files into HTML API references, making it a practical choice for Java teams that want documentation alongside their JDK-based development workflow. Its strength is producing conventional reference pages with room for custom output; it is not a substitute for an interactive API portal or a tool that repairs documentation errors.

Key features

The standard doclet describes public and protected Java types and members, including classes, interfaces, constructors, methods, and fields. It can process packages, individual source files, or both, and recursively include subpackages. That flexibility suits both project-wide reference builds and narrower documentation tasks.

Alternate doclets can change the content and format of generated pages, while taglets let teams add custom tags to documentation comments. Javadoc supports code samples, but it does not import OpenAPI or provide an interactive API reference. Choose it for Java source-based reference material, not when readers need to explore or try APIs in a browser.

DocLint can catch common problems in comments, but it does not verify full conformance or correct errors. Teams must still review and fix documentation, and take care with non-conformant output or generated pages containing executable content such as JavaScript, which Oracle identifies as potential sources of problems.

Pricing

Javadoc (included with JDK 25): free. The tool is installed with the JDK, and JDK 25 binaries are free under Oracle No-Fee Terms and Conditions through September 2028. This makes it a straightforward fit for Java developers already using the JDK, without a separate Javadoc plan or price.

The free terms have a boundary: after September 2028, JDK updates use the Java SE OTN License, which may require a fee for production use beyond its limited free grants. Organizations planning to stay on later updates for production should assess those terms. Oracle directs customers with active support contracts to My Oracle Support for technical questions and service requests.

Platforms

Oracle lists JDK 25 downloads for Linux, macOS, and Windows. Javadoc is installed with the JDK. Its supported operating systems also include UNIX, while the product’s deployment model is both and its hosting model is self-hosted, so it belongs in a locally managed development and documentation workflow rather than a hosted service.

Who it's for

Javadoc is best for Java library and application teams that want generated API references tied directly to source code, with the option to tailor page output or documentation tags. It is less appropriate for teams that need an interactive reference, OpenAPI import, or automatic validation and correction. Its clustering, admin console, and container support may matter to organizations managing deployment environments, but do not change its central role as a Java documentation generator.

Pros and cons

Pro: Included with the JDK, so Java teams can generate reference pages without adding a separate documentation product.

Pro: Alternate doclets, taglets, and recursive package processing support customized output across a codebase.

Con: DocLint only identifies common comment problems; teams remain responsible for conformance checks and corrections.

Con: No OpenAPI import or interactive API reference, making it a poor fit for browser-based API exploration.

Con: Free JDK 25 updates under Oracle's NFTC terms end after September 2028; later production use may incur fees under the OTN License.

Alternatives

Doxygen is a free option for teams looking for documentation generation across Windows, Linux, and macOS. For a wider API documentation shortlist, see API Documentation Tools; Profiling Software is another directory category.

Scalar suits readers comparing freemium API documentation products, with a free tier capped at three APIs, one SDK of up to 25 endpoints, one editor seat, and 50 Agent Scalar credits. Fern is another freemium choice; its free tier includes one site, up to 10 team members and 1,000 pages, plus monthly page-generation and AI-credit limits.

PilotDocs offers web-based freemium plans, including a $49 a month Starter plan with 10 projects and unlimited API endpoints, guides, and tutorials. Swagger Codegen is a free, open-source alternative that generates API clients, server stubs, and documentation from OpenAPI specifications, making it a better match for projects centered on OpenAPI.

ApiNotes has a free tier for one public API, a 10-release changelog, up to 25 subscribers, and one team member. pdoc is a free alternative for readers comparing documentation tools across Linux, macOS, Windows, self-hosted, and web platforms. Theneo is a freemium option for readers considering API documentation with web, extension, or self-hosted platforms.

Verdict

Choose Javadoc if you maintain Java code and want JDK-included HTML API references that can be adapted with doclets and taglets. Its source-linked workflow is the main reason to use it; look elsewhere if you need interactive API exploration, OpenAPI import, or stronger documentation validation, and review Oracle's later-update licensing terms before committing to a long production lifecycle.