Doclet: Difference between revisions
m (→The ANT Doclet) |
|||
| (3 intermediate revisions by the same user not shown) | |||
| Line 7: | Line 7: | ||
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. | ||
The motivation for writing this doclet is to ease the maintenance of the documentation for the [[ | The motivation for writing this doclet is to ease the maintenance of the documentation for the [[Antology]] antlib. | ||
[[ANT doclet|Read more...]] | [[ANT doclet|Read more...]] | ||
== The | == The CheckStyle Doclet == | ||
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 | 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 tags" in the source code of your checks and filters. | ||
[[Cs-doclet|Read more...]] | |||
== The JAVADOC Doclet == | |||
A re-implementation of the JAVADOC standard doclet, basically a reference to show how to use [https://github.com/aunkrig/no-template the "no-template" framework]. | |||
Generates | [[JAVADOC doclet|Read more...]] | ||
== The MAIN Doclet == | |||
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...]] | |||
Latest revision as of 16:47, 12 February 2017
<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[edit]
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.
The CheckStyle Doclet[edit]
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.
The JAVADOC Doclet[edit]
A re-implementation of the JAVADOC standard doclet, basically a reference to show how to use the "no-template" framework.
The MAIN Doclet[edit]
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.