Javadoc
oracle.com
- Free plan
- Windows
- macOS
- Linux
- Web
What Javadoc is
Javadoc generates HTML API documentation pages from Java source files and comes with the Java Development Kit (JDK). Its standard doclet creates pages for 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. Alternate doclets let developers define generated content and format, while taglets support custom tags in documentation comments. The standard doclet includes DocLint to help find common comment problems, but it does not verify conformance or correct errors. Oracle advises users to consider risks from non-conformant output or output containing executable content such as JavaScript. Oracle lists JDK 25 downloads for Linux, macOS, and Windows. JDK 25 binaries are free under Oracle No-Fee Terms and Conditions through September 2028; subsequent updates use the Java SE OTN License, which may require a fee for production use beyond limited free grants. Customers with active support contracts can direct technical questions to My Oracle Support.
Who it suits
Javadoc suits Java developers who need to generate API documentation from source files and documentation comments. It also supports teams that need to customize generated output through alternate doclets or taglets.
Good to know, and what to watch
- Generates HTML API documentation from Java source
- Can document packages, files, and recursive subpackages
- Alternate doclets and taglets support customized output
- JDK 25 binaries are free under Oracle terms through September 2028
- DocLint does not verify conformance or correct errors
- Later updates may require production-use fees beyond limited grants
- Oracle directs technical support questions to customers with active support contracts
Plans
Every plan and priceJavadoc (included with JDK 25)
30-day trial
Getting started
- Download the JDK for Linux, macOS, or Windows
- Install the JDK, which includes Javadoc
- Select packages, source files, or both as documentation inputs
- Generate HTML with the standard doclet
- Add alternate doclets or taglets when custom output or tags are needed
- Review generated output and DocLint findings
Limits to check
JDK 25 binaries are free under Oracle No-Fee Terms and Conditions through September 2028. Later updates use the Java SE OTN License, which may require a production-use fee beyond limited free grants.
The Club's review
Overview
Javadoc converts Java source files and their documentation comments into HTML API reference pages. It suits developers and teams maintaining Java libraries or applications who want documentation generated alongside the code, especially when they already use the Java Development Kit. The trade-off is a source-oriented reference generator rather than a hosted, interactive documentation portal.
Key features
The standard doclet produces HTML pages for public and protected types and members, including classes, interfaces, constructors, methods, and fields. It can process complete packages, selected source files, or both, and can recursively include subpackages. That range makes it practical for documenting an entire codebase or producing a focused reference for a smaller component.
Javadoc is more adaptable than a fixed template suggests. Alternate doclets can change the content and format of generated output, while taglets add custom tags to documentation comments. Code samples are supported, helping readers understand method usage. It does not import OpenAPI definitions or provide an interactive API reference, so teams whose users expect browser-based endpoint exploration will need another tool or an additional layer.
DocLint identifies common problems in documentation comments, but it does not certify conformance or correct errors. A review and cleanup step remains necessary. Oracle also warns that non-conformant output and generated pages containing executable content such as JavaScript can create problems, so publishing pipelines should treat generated HTML as an output to inspect rather than an automatically trusted artifact.
Pricing
Javadoc is a paid product model with a 30-day trial and a free option through its JDK inclusion. The listed Javadoc plan costs free: it is included with the JDK, and JDK 25 binaries are free under Oracle No-Fee Terms and Conditions through September 2028. Oracle says updates after that point use the Java SE OTN License, which may require a production-use fee beyond its limited free grants. Organizations with active support contracts are directed to My Oracle Support for technical questions and service requests.
There are no seat quotas or hosted-service allowances attached to this included tool. The practical cost is therefore tied to Oracle’s licensing terms and to the engineering work of reviewing and publishing the generated pages. It is a strong fit for teams already standardizing on JDK 25; teams planning long-lived production deployments should budget for the post-September 2028 licensing change.
Platforms
Javadoc is self-hosted and runs wherever the JDK is installed. Oracle lists JDK 25 downloads for Linux, macOS, and Windows, while the supported operating-system listing also includes UNIX. It supports both deployment models and is identified with Jakarta EE and Java environments. Clustering, an admin console, and container support are listed capabilities, useful for organizations that need to place documentation generation within managed or containerized infrastructure rather than rely on a vendor-hosted site.
Who it's for
Choose Javadoc for Java teams that want source-linked API reference, repeatable package or file-level generation, and the option to customize output with doclets and taglets. It is particularly sensible when the JDK is already a required build dependency and documentation belongs in the same delivery pipeline as the code.
Look elsewhere when the audience needs interactive endpoint testing, OpenAPI import, a hosted portal, or automated correction of documentation defects. Javadoc creates reference pages; it does not turn them into a complete product-documentation experience.
Pros and cons
Pros
- Included with the JDK: The free JDK 25 plan removes a separate tool purchase through September 2028 under Oracle’s stated terms.
- Flexible source coverage: Packages, individual files, and recursive subpackages support both broad and targeted documentation runs.
- Extensible output: Alternate doclets and taglets let teams tailor formats and metadata beyond the standard pages.
- Broad deployment fit: Linux, macOS, Windows, and UNIX support, plus container and clustering capabilities, fit varied internal build environments.
Cons
- Limited validation: DocLint flags common issues but does not prove conformance or fix mistakes.
- No interactive or OpenAPI workflow: There is no OpenAPI import or interactive API reference for browser-based endpoint exploration.
- Licensing changes matter: JDK 25 updates move to the Java SE OTN License after September 2028, with possible production fees.
- Output requires care: Non-conformant or executable generated content can introduce problems and needs review before publication.
Alternatives
Swagger Codegen is the better choice when OpenAPI specifications should generate API clients, server stubs, and documentation, and an open-source tool is preferred.
Doxygen fits teams documenting languages beyond Java that want free, open-source software with Windows, Linux, and macOS downloads.
PilotDocs suits a web-based documentation service with freemium plans, including a $49.00-per-month Starter plan for 10 projects and unlimited API endpoints.
ApiNotes is aimed at hosted API documentation with a free public-only starter tier and team-oriented paid plans.
Scalar is an option for teams wanting web, API, or self-hosted coverage, with a free tier for up to three APIs and one editor seat.
Fern provides a freemium, multi-platform documentation workflow with a free tier for 10 team members and one site.
Palt is suited to web projects seeking a free tier with three projects and a custom domain, plus paid upgrades.
phpDocumentor is a free, open-source documentation tool for PHP rather than Java.
Browse API Documentation Tools for a wider category comparison, or Profiling Software when runtime performance analysis is the actual requirement.
Verdict
Javadoc is the right choice for Java developers who want dependable, source-driven API reference generated from a tool already included with the JDK, with meaningful customization through doclets and taglets. Look elsewhere if you need an interactive hosted portal, OpenAPI-based workflows, or stronger automated validation, and review Oracle’s licensing transition before committing production systems beyond September 2028.
The verdict
Javadoc provides a built-in way to generate and customize Java API documentation. Review Oracle’s license terms for updates after September 2028 and account for DocLint’s limited validation role.
Questions people ask
Is Javadoc included with Java?
Yes. The Javadoc tool is installed with the Java Development Kit.
What does Javadoc generate?
Its standard doclet generates HTML pages describing public and protected Java types and members.
Which operating systems are listed?
Oracle lists JDK 25 downloads for Linux, macOS, and Windows; supported operating systems also include Linux, UNIX, and Windows.
Can Javadoc use custom documentation formats?
Yes. Alternate doclets can define output content and format, and taglets support custom tags.
Is Javadoc free?
The Javadoc plan is included with the JDK at no cost. JDK 25 binaries are free under Oracle No-Fee Terms and Conditions through September 2028.
What the maker publishes
- Custom output
- Javadoc supports alternate doclets that define the content and format of generated output. source
- Custom tags
- Custom tags in documentation comments are supported through taglets. source
- Founded
- 1977 source
- Headquarters
- Austin, Texas, USA source
- Inputs
- Javadoc can document whole packages, individual Java source files, or both, and can recursively include subpackages. source
- JDK inclusion
- The Javadoc tool is installed with the Java Development Kit (JDK). source
- License limit
- Oracle says JDK 25 updates are free under NFTC through September 2028; subsequent updates use the Java SE OTN License, which may require a fee for production use beyond its limited free grants. source
- Maker founding
- Oracle says it was founded in 1977. source
- Operating systems
- Oracle lists JDK 25 downloads for Linux, macOS, and Windows. source
- Output safety
- Oracle advises users to be aware of problems that may arise from non-conformant output or output containing executable content such as JavaScript. source
- Purpose
- Javadoc generates HTML API documentation pages from Java source files. source
- Standard output
- The standard doclet generates HTML pages describing public and protected types and members, including classes, interfaces, constructors, methods, and fields. source
- Support
- Oracle directs customers with active support contracts to My Oracle Support for technical questions and service requests. source
- Validation
- The standard doclet provides DocLint to help detect common problems in documentation comments, but does not validate their conformance or correct errors. source
Checked against the maker's pages on 4 Oct 2026.