public
Description: OpenJavaDocCheck
Homepage:
Clone URL: git://github.com/egonw/ojdcheck.git
name age message
file LICENSE Fri Oct 16 05:59:48 -0700 2009 Added text of the new BSD license [egonw]
file README.rst Sun Oct 18 00:32:59 -0700 2009 Added clarification on how gjdoc is involved, w... [egonw]
file build.xml Wed Oct 21 23:08:37 -0700 2009 Added a build script [rajarshi]
directory com.github.ojdcheck/ Thu Nov 12 22:53:19 -0800 2009 Updated missing exception description class bas... [rajarshi]
file ojdcheckXHTML.png Sat Oct 17 09:26:57 -0700 2009 Added screenshot of the XHTML output [egonw]
README.rst

Open JavaDoc Check

Project where I plan to write an Open Source DocCheck alternative.

http://github.com/egonw/ojdcheck/raw/master/ojdcheckXHTML.png

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

  1. Open the com.github.ojdcheck project in Eclipse and build.
  2. 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.