Mercurial > jdk8-mips64-public > langtools / annotate
test/tools/doclint/tidy/README.txt@153d0309e698 (annotated)
test/tools/doclint/tidy/README.txt
Mon, 31 Aug 2015 13:37:01 -0700
- author
- asaha
- date
- Mon, 31 Aug 2015 13:37:01 -0700
- changeset 2971
- 153d0309e698
- parent 0
- 959103a6100f
- permissions
- -rw-r--r--
Added tag jdk8u65-b12 for changeset 54e958a3719e
| aoqi@0 | 1 | The utilities in this directory can be used to determine |
| aoqi@0 | 2 | common issues in javadoc comments by running the standard |
| aoqi@0 | 3 | "tidy" program on the output of javadoc, and analysing |
| aoqi@0 | 4 | the messages that are reported. |
| aoqi@0 | 5 | |
| aoqi@0 | 6 | tidy.sh is a script that will run the "tidy" program on |
| aoqi@0 | 7 | the files in a directory, writing the results to a new |
| aoqi@0 | 8 | directroy. |
| aoqi@0 | 9 | |
| aoqi@0 | 10 | tidystats.Main is a Java program that can analyze the |
| aoqi@0 | 11 | files produced by the tidy.sh script to generate a |
| aoqi@0 | 12 | summary report about the warnings that were found. |
| aoqi@0 | 13 | |
| aoqi@0 | 14 | |
| aoqi@0 | 15 | The tests is this directory are focussed on verifying |
| aoqi@0 | 16 | that doclint detects issues in javadoc comments that will |
| aoqi@0 | 17 | give rise to issues detected by "tidy" in the output |
| aoqi@0 | 18 | generated by javadoc. |
| aoqi@0 | 19 | |
| aoqi@0 | 20 | For more information on the "tidy" program, see the HTML Tidy |
| aoqi@0 | 21 | Library Project page at http://tidy.sourceforge.net/. |
