Developers are lazy and don't like to write comments even these might be crucial to the success
of a software project.
The Javadoc Checker is a small tool that forces developers to do the documentation.
It checks whether the javadoc information of java files is
complete upon a CVS commit. No class with incomplete or incorrect
comments will be accepted be the CVS server.
The conditions for invalid comments can be specified using regular
expressions (either by using the -properties option
or by changing the default properties file).
You might specify there what elements of your code needs to be checked.
Checking can be enabled on classes, methods and member variables depending on their visibility
(public, protected, private).
You can either download a precompiled jar file or the source distribution.
The source distribution contains an Ant build file. To compile all the source just extract the zip file and run ant. If you experience problems upon compiling the path to your tools.jar file is probably wrong. You can correct it in the build.xml file.
To use the Javadoc Checker you'll need JDK 1.4 (or newer) installed on your CVS machine.
The Javadoc Checker should be called in the commitinfo file in
CVSROOT by adding the following line:
DEFAULT <JAVA_HOME>/bin/java -classpath <CLASSPATH>:<JAVA_HOME>/lib/tools.jar de.acid.tools.JavadocChecker
Replace <JAVA_HOME> and <CLASSPATH> with your
specific values. Make sure the path to the tools.jar file is correct.
The Javadoc Checker was written by Mirko Seifert. If you have any questions send an email to javadocchecker [at] cive.de.