Doclet
m (→The MAIN Doclet) |
m (→The MAIN Doclet) |
||
| Line 25: | Line 25: | ||
== The MAIN Doclet == | == The MAIN Doclet == | ||
| − | Generates an HTML page for the | + | Generates an HTML page for the <code>main(String[])</code> method (or any other method) of each of the specified classes. This is useful for command line tools with a set of command line options. Converted to plain text (e.g. with the [[html2txt]] utility), that documentation is perfect for a self description that a command line utility would print in response to <code>--help</code>. |
[[MAIN doclet|Read more...]] | [[MAIN doclet|Read more...]] | ||
Latest revision as of 16:47, 12 February 2017
This site makes several doclets publicly available which I wrote for my personal needs, but are hopefully useful for others. Enjoy!
Contents |
[edit] 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 Antology antlib.
[edit] The CheckStyle Doclet
Generates (JAVADOC-like) HTML documentation and the metadata files for CheckStyle and Eclipse-CS plugin-ins from "doc tags" in the source code of your checks and filters.
[edit] The JAVADOC Doclet
A re-implementation of the JAVADOC standard doclet, basically a reference to show how to use the "no-template" framework.
[edit] The MAIN Doclet
Generates an HTML page for the main(String[]) method (or any other method) of each of the specified classes. This is useful for command line tools with a set of command line options. Converted to plain text (e.g. with the html2txt utility), that documentation is perfect for a self description that a command line utility would print in response to --help.
