/maindoc

A tool for generating documentation for a single Java method from doc comments, similar to JAVADOC. The primary use case is "--help" output for command line tools.

Primary LanguageJava

maindoc

A tool for generating documentation for a single Java method from doc comments, similar to JAVADOC

Comprises the following artifacts:

The MAVEN plugin uses the Doclet to run JAVADOC and generate the MAINDOC.

Example

The DOC comments in this Java source file

https://github.com/aunkrig/zz/blob/master/zz-patch/src/main/java/de/unkrig/zz/patch/Main.java

produce this HTML document:

http://zz.unkrig.de/maindoc/zz-patch/Main.main(String%5b%5d).html

Change Log

See here.