JAVADOC doclet: Difference between revisions

From unkrig.de
Jump to navigation Jump to search
(Created page with "== The JAVADOC Doclet == A drop-in replacement for the standard JAVADOC doclet that is part of the JAVADOC utility which ships with the JDK. The main motivation was to devel...")
 
mNo edit summary
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
== The JAVADOC Doclet ==
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.


A drop-in replacement for the standard JAVADOC doclet that is part of the JAVADOC utility which ships with the JDK.
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).


The main motivation was to develop a slick framework the would help me (and others) to implement other doclets (see below) more easily. 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.
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 my JAVADOC 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 mine.
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 ===


; -d ''dest-dir''
; -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''
; -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''
; -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''
; -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''
; -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''
; -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''
; -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
; -notimestamp
: Same as for the original JAVADOC doclet.
: Same as [https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDGBABE the -notimestamp option of the original JAVADOC doclet].


=== Resources ===
=== Resources ===

Latest revision as of 13:17, 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 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[edit]

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[edit]

-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[edit]

Find the source code here.

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