OpenJDK / lambda / lambda / langtools
annotate test/tools/doclint/tidy/README.txt @ 1714:6b07f409943e
merge with jdk8-b71
| author | mcimadamore |
|---|---|
| date | Wed, 09 Jan 2013 17:55:02 +0100 |
| parents | |
| children |
| rev | line source |
|---|---|
| mcimadamore@1714 | 1 The utilities in this directory can be used to determine |
| mcimadamore@1714 | 2 common issues in javadoc comments by running the standard |
| mcimadamore@1714 | 3 "tidy" program on the output of javadoc, and analysing |
| mcimadamore@1714 | 4 the messages that are reported. |
| mcimadamore@1714 | 5 |
| mcimadamore@1714 | 6 tidy.sh is a script that will run the "tidy" program on |
| mcimadamore@1714 | 7 the files in a directory, writing the results to a new |
| mcimadamore@1714 | 8 directroy. |
| mcimadamore@1714 | 9 |
| mcimadamore@1714 | 10 tidystats.Main is a Java program that can analyze the |
| mcimadamore@1714 | 11 files produced by the tidy.sh script to generate a |
| mcimadamore@1714 | 12 summary report about the warnings that were found. |
| mcimadamore@1714 | 13 |
| mcimadamore@1714 | 14 |
| mcimadamore@1714 | 15 The tests is this directory are focussed on verifying |
| mcimadamore@1714 | 16 that doclint detects issues in javadoc comments that will |
| mcimadamore@1714 | 17 give rise to issues detected by "tidy" in the output |
| mcimadamore@1714 | 18 generated by javadoc. |
| mcimadamore@1714 | 19 |
| mcimadamore@1714 | 20 For more information on the "tidy" program, see the HTML Tidy |
| mcimadamore@1714 | 21 Library Project page at http://tidy.sourceforge.net/. |