JAVADOC doclet: Difference between revisions
mNo edit summary |
|||
| Line 1: | Line 1: | ||
A drop-in replacement for the standard JAVADOC doclet that is part of the JAVADOC utility which ships with the JDK. | 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 | The main motivation was to demonstrate the capabilities of the [No-template|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 === | === Getting started === | ||
To use | To use this doclet, you must run the JAVADOC utility exactly as usual, but pass <code>-doclet</code> and <tt>-docletpath</tt> command line options to replace the built-in doclet with the new one. | ||
=== Doclet Options === | === Doclet Options === | ||
Revision as of 12:43, 2 June 2016
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|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
- -windowtitle text
- -doctitle text
- -header text
- -footer text
- -top text
- -bottom text
- -notimestamp
- Same as for the original JAVADOC doclet.
Resources
Find the source code here.
Ready-to-use binaries are not (yet) available.