Javadoc Technology

Javadoc is a tool that parses the declarations and documentationcomments in a set of source files and produces a set of HTML pagesdescribing the classes, interfaces, constructors, methods, andfields.

You can use a Javadoc doclet to customize Javadoc output. Adoclet is a program written with the Doclet API that specifies thecontent and format of the output to be generated by the Javadoctool. You can write a doclet to generate any kind of text-fileoutput, such as HTML, SGML, XML, RTF, and MIF. Sun™ providesa "standard" doclet for generating HTML-format API documentationand an experimental MIF doclet for generating MIF, PDF, FrameMaker,and other formats. Doclets can also be used to perform specialtasks not related to producing API documentation.

A taglet is a program that allows you to create and use customtags that are more flexible than custom tags created with the -tagoption. A custom tag is used by a doclet to format and display textfrom a Javadoc tag. A taglet must implement the tagletinterface.

API Specification

DocletAPI - Documentation for thecom.sun.javadocpackage, which comprises the Doclet API.
Taglet API - Documentation for thecom.sun.tools.doclets.Taglet class, which comprises theTaglet API.

Tools

The following pages list all javadoc tags and command-line optionsfor running the Javadoc tool, with examples for Solaris andMicrosoft Windows.

Tutorials and Programmer's Guides

Doclet Information:

Doclet Overview -Introduction to doclets with simple examples that illustrate theDoclet API.
Running the StandardDoclet - This doclet produces the default HTML-formattedAPI documentation. Javadoc uses the standard doclet if no otherdoclet is specified with Javadoc's-doclet option.
Transitioningto the 5.0 Doclet API - Tips to extend legacy doclets tosupport 5.0 new language features.

Taglet Information:

Taglet Overview -Introduction to taglets with simple examples that illustrate theTaglet API.

API Enhancements

More Information