Editing JAVADOC doclet

Jump to navigation Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
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. 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 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.
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.


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


=== Resources ===
=== Resources ===
Please note that all contributions to unkrig.de may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see Unkrig.de:Copyrights for details). Do not submit copyrighted work without permission!
Cancel Editing help (opens in new window)
Retrieved from "https://unkrig.de/w/JAVADOC_doclet"