egonw / ojdcheck
- Source
- Commits
- Network (2)
- Issues (3)
- Graphs
-
Branch:
master
| name | age | message | |
|---|---|---|---|
 |
LICENSE | Loading commit data...  |
|
| |
README.rst | ||
| |
build.xml | ||
 |
com.github.ojdcheck/ | ||
| |
ojdcheckXHTML.png |
Open JavaDoc Check
Project where I plan to write an Open Source DocCheck alternative.
Why?
I keep not finding an Open alternative for DocCheck. And how hard can it be to write one myself?
License
New BSD.
License of files in jar/
The jar binaries in the com.github.ojdcheck/jar folder are copied from the Ubuntu gjdoc package, license GPL v2. See:
http://changelogs.ubuntu.com/changelogs/pool/main/g/gjdoc/gjdoc_0.7.9-1/gjdoc.copyright
This library does not depend on gjdoc, but on the JavaDoc APIs instead upon compile time, as well as runtime.
Howto
- Open the com.github.ojdcheck project in Eclipse and build.
- cd com.github.ojdcheck
In that directory you can give the code a test run:
javadoc -doclet com.github.ojdcheck.OpenJavaDocCheck -docletpath bin -sourcepath src com.github.ojdcheck
The Doclet has several options. One is used to set the location of the output file, a second to give a comma-separated list of custom tests (implementing ICheckDocTest). For example:
javadoc -file report.xml -tests com.github.ojdcheck.test.FooMethodTest -doclet com.github.ojdcheck.OpenJavaDocCheck -docletpath bin -sourcepath src com.github.ojdcheck
The third option is to control the output type, and you can use -xml and -xhtml. A fourth option, -customonly, will only use the tests passed with the -tests command.
