Doclet: Difference between revisions

From unkrig.de
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 3: Line 3:
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!


== [[ANT doclet|ANT Doclet]] ==
== The [[ANT doclet|ANT Doclet]] ==
: Generates JAVADOC-like HTML documentation for an ANTLIB, e.g. [[Ant-contrib.unkrig.de]].
 
== [[Cs-doclet|CheckStyle Doclet]] ==
: Generates the metadata files for CheckStyle and eclipse-cs from 'doc tags' in the source code of your checks and filters.
 
== [[JAVADOC doclet|JAVADOC Doclet]] ==
: A re-implementation of the JAVADOC standard doclet, basically a reference to show how to use the "no-template" framework.
 
== [[MAIN doclet|MAIN Doclet]] ==
: Generates HTML documentation for a "main()" method - useful for command line tools with a set of command line options.
 
 
 
 
 
 
 
 
 
 
 
 
== The ANT Doclet ==


Generates (JAVADOC-like) HTML documentation for [http://ant.apache.org APACHE ANT] antlibs.
Generates (JAVADOC-like) HTML documentation for [http://ant.apache.org APACHE ANT] antlibs.
Line 32: Line 9:
The motivation for writing this doclet is to ease the maintenance of the documentation for the [[Ant-contrib.unkrig.de]] antlib.
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.
== The [[Cs-doclet|CheckStyle Doclet]] ==
 
=== Resources ===
 
Find the source code for the doclet [https://svn.code.sf.net/p/loggifier/code/trunk/de.unkrig.doclet.ant here].
 
 
== 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].
 
Find the documentation [[Cs-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 <code>-doclet</code> and <tt>-docletpath</tt> command line options to replace the built-in doclet with mine.
 
=== 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 [https://svn.code.sf.net/p/loggifier/code/trunk/de.unkrig.doclet.javadoc here].
 
Ready-to-use binaries are not (yet) available.
 
== The MAIN Doclet ==
 
This doclet creates a (very simple) HTML page for the "'''main(String[])'''" method (or a different method) of each of the specified classes.
 
=== Doclet options ===
 
; -d ''dest-dir''
: Where to create the output files. The complete output file name is "''dest-dir''/pkg/pkg/class.meth(int, String)".


; -method ''method-signature''
Generates (JAVADOC-like) HTML documentation and the metadata files for [http://checkstyle.sf.net CheckStyle] and [http://eclipse-cs.sf.net Eclipse-CS] plugin-ins from "doc tas" in the source code of your checks and filters.
: Which method to document; defaults to "'''main(String[])'''".


; -output-encoding ''enc''
== The [[JAVADOC doclet|JAVADOC Doclet]] ==
: The encoding to use when writing output files; defaults to the "JVM default charset".


=== Resources ===
A re-implementation of the JAVADOC standard doclet, basically a reference to show how to use the "no-template" framework.


Find the source code [https://svn.code.sf.net/p/loggifier/code/trunk/de.unkrig.doclet.main here].
== The [[MAIN doclet|MAIN Doclet]] ==


Ready-to-use binaries are not (yet) available.
Generates a (very simple) HTML page for the "'''main(String[])'''" method (or a different method) of each of the specified classes. This is useful for command line tools with a set of command line options.

Revision as of 16:06, 16 February 2016

<meta name="keywords" content="java, doclet"></meta> <meta name="description" content="Several useful doclets for use with JAVADOC"></meta> This site makes several doclets publicly available which I wrote for my personal needs, but are hopefully useful for others. Enjoy!

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.

The CheckStyle Doclet

Generates (JAVADOC-like) HTML documentation and the metadata files for CheckStyle and Eclipse-CS plugin-ins from "doc tas" in the source code of your checks and filters.

The JAVADOC Doclet

A re-implementation of the JAVADOC standard doclet, basically a reference to show how to use the "no-template" framework.

The MAIN Doclet

Generates a (very simple) HTML page for the "main(String[])" method (or a different method) of each of the specified classes. This is useful for command line tools with a set of command line options.

Retrieved from "https://unkrig.de/STRATO-apps/mediawiki_03/app/index.php?title=Doclet&oldid=804"