Aunkrig: Created page with "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 co..."

2024-05-01T18:54:38Z

Created page with "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 co..."

New page

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 <code>-doclet</code> and <tt>-docletpath</tt> command line options to replace the built-in doclet with the new one.

=== Doclet Options ===

; -d ''dest-dir''
: Same as [https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDBDAED the -d option of the original JAVADOC doclet].

; -windowtitle ''text''
: Same as [https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDBIEEI the -windowtitle option of the original JAVADOC doclet].

; -doctitle ''text''
: Same as [https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDJGBIE the -doctitle option of the original JAVADOC doclet].

; -header ''text''
: Same as [https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDDAEGD the -header option of the original JAVADOC doclet].

; -footer ''text''
: Same as [https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDFACCA the -footer option of the original JAVADOC doclet].

; -top ''text''
: Same as [https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDHHGBF the -top option of the original JAVADOC doclet].

; -bottom ''text''
: Same as [https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDECAJE the -bottom option of the original JAVADOC doclet].

; -notimestamp
: Same as [https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDGBABE the -notimestamp option of the original JAVADOC doclet].

=== Resources ===

Find the source code [https://svn.code.sf.net/p/loggifier/code/trunk/de.unkrig.doclet.javadoc here].

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

JAVADOC doclet - Revision history