oakbot-doclet is a command-line tool that generates special ZIP files used by OakBot for displaying Javadoc information. These ZIP files contain XML files, which contain the Javadoc information of all the classes in a Java library. It builds these ZIP files using a custom Javadoc "doclet", which is used by the "javadoc" tool.
oakbot-doclet requires Java 1.8 and uses the Maven build system.
The easiest way to build it is to create a fat JAR like so:
mvn test assembly:single
| Argument | Description |
|---|---|
-v, --verbose |
Give verbose output. |
-i |
Interactive mode. Asks you questions and accepts input from the keyboard. An alternative to providing command-line arugments. |
-h, --help |
Displays a help message. |
--maven |
The Maven coordinates of the library. If the library is not on Maven Central, use the --src, --name, and --ver arguments instead. Format: groupId:artfactId:version. |
--src |
The path to a ZIP file, JAR file, or directory that contains the library's source code. Use this if the library is not on Maven Central. |
--name |
The name of the library. Use this if the library is not on Maven Central. |
--ver |
The version of the library. Use this if the library is not on Maven Central. |
--excludePackages |
(optional) A comma-separated list of packages to exclude from the Javadoc processing. |
--javadocUrl |
(optional) The URL to the library's Javadocs. |
--website |
(optional) The URL to the library's website. |
--prettyPrint |
(optional) If specified, pretty-prints the XML that is generated by this tool. |
--output |
(optional) The path to where the generated ZIP file will be saved. If not specified, the ZIP file will be saved to the current directory with a name based on the --name and --ver arguments. |
Generate a ZIP file for the jsoup library:
java -jar oakbot-doclet.jar \
--maven=org.jsoup:jsoup:1.8.3 \
--javadocUrl=http://jsoup.org/apidocs/ \
--website=http://jsoup.org/
Generate a ZIP file for Java 8:
java -jar oakbot-doclet.jar \
--src=java8-src.zip \
--excludePackages=com \
--name=java \
--ver=8 \
--javadocUrl=http://docs.oracle.com/javase/8/docs/api/ \
--website=http://www.oracle.com/java