Javadoc – generate API documentation from Java source code

Javadoc is a documentation generator included with the Java Development Kit. It creates structured HTML API references by analysing Java source code and specially formatted documentation comments.

Java developers use Javadoc comments to explain the purpose and behaviour of classes, methods and other program elements. These comments can describe how to call a method, what values it accepts and returns, and which exceptions may be thrown. The generator combines this information with details extracted from the source code.

Javadoc is widely used by Java libraries and frameworks, including the Java platform itself. Its integration with the Java development ecosystem helps maintain consistency between public interfaces and their documentation. Custom extensions allow developers to adapt the generation process to more specialised requirements.

This is free and open source software.

Key Features

• Generates HTML API documentation from Java source code and documentation comments.
• Organises documentation by modules, packages, classes, interfaces, constructors, methods and fields.
• Produces navigable class hierarchies, inheritance information and package summaries.
• Supports standard documentation tags for parameters, return values, exceptions, references and deprecation notices.
• Creates searchable documentation with indices and links between related API elements.
• Supports links to external API documentation, including references to Java platform classes.
• Doclet API allows developers to customise the processing and presentation of documentation.
• Taglet API supports custom documentation tags and their rendered output.
• Includes facilities for documenting generic types, annotations and records.
• Cross-platform support – runs on Linux, macOS, and Windows.

Website: www.oracle.com
Support:
Developer: Oracle and OpenJDK contributors
License: GNU General Public License v2.0 with the Classpath Exception (OpenJDK)

Javadoc is written in Java. Learn Java with our recommended free books and free tutorials.

Related Software

Read our verdict in the software roundup.

LinuxLinks helps you discover the best free and open source software for Linux. Explore our extensive collection of recommended applications, including alternatives to popular proprietary software. We also publish software reviews, Linux tutorials, hardware reviews, free programming books and articles covering the wider open source community. Browse our Linux resources to discover more. Know a useful free and open source Linux application we haven't covered? Suggest a program for inclusion. Has your software been featured on LinuxLinks? Display one of our Featured on LinuxLinks badges on your website or GitHub README.