 |
 |
 |
 |
 |
 |
 |
 |
Javadoc is a tool from Sun Microsystems for generating API documentation in HTML format from doc comments in source code.
Javadoc is a tool that parses the declarations
and documentation comments in a set of source files and produces a set
of HTML pages describing the classes, inner classes, interfaces, constructors,
methods, and fields.
You can use Javadoc
doclets to customize Javadoc output. A doclet is a program written
with the doclet API that specifies the content and format of the output
to be generated by the javadoc tool. You can write a doclet to generate
any kind of text-file output, such as HTML, SGML, XML, RTF, and MIF. Sun™
provides a "standard" doclet for generating HTML-format API
documentation and an experimental MIF doclet for generating MIF, PDF,
PS, RTF, FrameMaker, and other formats. Doclets can also be used to perform
special tasks not related to producing API documentation. For example,
a diagnostic doclet could be created to check that all class members of
the classes on which Javadoc operates have documentation comments.
[FAQ]