Doclet: Difference between revisions
(Created page with "This site makes several doclets publicly available which I wrote for my personal needs, but are hopefully useful for others. Enjoy! == The JAVADOC Doclet == A drop-in replac...") |
No edit summary |
||
| Line 1: | Line 1: | ||
This site makes several doclets publicly available which I wrote for my personal needs, but are hopefully useful for others. Enjoy! | This site makes several doclets publicly available which I wrote for my personal needs, but are hopefully useful for others. Enjoy! | ||
== The CheckStyle Doclet == | |||
Generates MEDIAWIKI-format documentation for [http://checkstyle.sf.net CheckStyle] and [http://eclipse-cs.sf.net Eclipse-CS] plugin-ins. | |||
The motivation for writing this doclet was to ease the maintenance of the documentation for the [[Cs-contrib.unkrig.de]] CheckStyle plug-in. See [[Cs-contrib.unkrig.de_/_Checks_/_Name_spelling|here]] for an example generated page. | |||
The generation of MEDIAWIKI documentation will be replaced with (JAVADOC-like) HTML documents. | |||
=== Resources === | |||
Find the jar file [http://unkrig.de/doclet/cs/download/ here]. | |||
Find the source code for the doclet [https://svn.code.sf.net/p/loggifier/code/trunk/de.unkrig.doclet.cs here]. | |||
== The ANT Doclet == | |||
Generates (JAVADOC-like) HTML documentation for [http://ant.apache.org APACHE ANT] antlibs. | |||
The motivation for writing this doclet is to ease the maintenance of the documentation for the [[Ant-contrib.unkrig.de]] antlib. | |||
It is not (yet) completely functional. | |||
=== Resources === | |||
Find the source code for the doclet [https://svn.code.sf.net/p/loggifier/code/trunk/de.unkrig.doclet.ant here]. | |||
== The JAVADOC Doclet == | == The JAVADOC Doclet == | ||
| Line 10: | Line 38: | ||
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 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. | ||
=== 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. | |||
Revision as of 11:04, 18 August 2015
This site makes several doclets publicly available which I wrote for my personal needs, but are hopefully useful for others. Enjoy!
The CheckStyle Doclet
Generates MEDIAWIKI-format documentation for CheckStyle and Eclipse-CS plugin-ins.
The motivation for writing this doclet was to ease the maintenance of the documentation for the Cs-contrib.unkrig.de CheckStyle plug-in. See here for an example generated page.
The generation of MEDIAWIKI documentation will be replaced with (JAVADOC-like) HTML documents.
Resources
Find the jar file here.
Find the source code for the doclet here.
The ANT Doclet
Generates (JAVADOC-like) HTML documentation for APACHE ANT antlibs.
The motivation for writing this doclet is to ease the maintenance of the documentation for the Ant-contrib.unkrig.de antlib.
It is not (yet) completely functional.
Resources
Find the source code for the doclet here.
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 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.
Getting started
To use my JAVADOC 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 mine.
Resources
Find the source code here.
Ready-to-use binaries are not (yet) available.