README.txt
1The utilities in this directory can be used to determine
2common issues in javadoc comments by running the standard
3"tidy" program on the output of javadoc, and analysing
4the messages that are reported.
5
6tidy.sh is a script that will run the "tidy" program on
7the files in a directory, writing the results to a new
8directroy.
9
10tidystats.Main is a Java program that can analyze the
11files produced by the tidy.sh script to generate a
12summary report about the warnings that were found.
13
14
15The tests is this directory are focussed on verifying
16that doclint detects issues in javadoc comments that will
17give rise to issues detected by "tidy" in the output
18generated by javadoc.
19
20For more information on the "tidy" program, see the HTML Tidy
21Library Project page at http://tidy.sourceforge.net/.
22