JAVADOC doclet

From unkrig.de
Jump to: navigation, search

A drop-in replacement for the standard JAVADOC doclet that is part of the JAVADOC utility which ships with the JDK. It implements many, but not all options of the original doclet.

The main motivation was to demonstrate the capabilities of the no-template framework; in particular its abstract templates that render "javadocish" pages. Effectively, this doclet re-implements the JDK's standard JAVADOC doclet with only 4900 lines of code (including tons of comments).

After all, JAVADOC is *the* reference application of a doclet, and anybody who wants to write a doclet knows it and has an idea of how to get from the JAVADOC doclet to *his* doclet.

Getting started

To use this doclet, you must run the JAVADOC utility exactly as usual, but pass -doclet and -docletpath command line options to replace the built-in doclet with the new one.

Doclet Options

-d dest-dir
Same as the -d option of the original JAVADOC doclet.
-windowtitle text
Same as the -windowtitle option of the original JAVADOC doclet.
-doctitle text
Same as the -doctitle option of the original JAVADOC doclet.
-header text
Same as the -header option of the original JAVADOC doclet.
-footer text
Same as the -footer option of the original JAVADOC doclet.
-top text
Same as the -top option of the original JAVADOC doclet.
-bottom text
Same as the -bottom option of the original JAVADOC doclet.
-notimestamp
Same as the -notimestamp option of the original JAVADOC doclet.

Resources

Find the source code here.

Ready-to-use binaries are not (yet) available.

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox