aoqi@0: The utilities in this directory can be used to determine
aoqi@0: common issues in javadoc comments by running the standard
aoqi@0: "tidy" program on the output of javadoc, and analysing
aoqi@0: the messages that are reported.
aoqi@0: 
aoqi@0: tidy.sh is a script that will run the "tidy" program on
aoqi@0: the files in a directory, writing the results to a new
aoqi@0: directroy.
aoqi@0: 
aoqi@0: tidystats.Main is a Java program that can analyze the 
aoqi@0: files produced by the tidy.sh script to generate a 
aoqi@0: summary report about the warnings that were found.
aoqi@0: 
aoqi@0: 
aoqi@0: The tests is this directory are focussed on verifying
aoqi@0: that doclint detects issues in javadoc comments that will
aoqi@0: give rise to issues detected by "tidy" in the output
aoqi@0: generated by javadoc. 
aoqi@0: 
aoqi@0: For more information on the "tidy" program, see the HTML Tidy
aoqi@0: Library Project page at http://tidy.sourceforge.net/.