Ensure that Javadoc links to the manual

[GoogleCodeExporter]

There should be a @checker_framework.manual Javadoc tag in every checker 
(namely, classes that extend BaseTypeChecker or AggregateChecker) and in every 
file in a qual/ or compatqual/ subdirectory.  That creates cross-references 
from the Javadoc (which may be the first thing many users see) to the manual.

The following is the start of a script that verifies that the documentation is 
present.  It would be nice to add to the Jenkins continuous integration server, 
and to ensure that it passes before making a release.

# There should be a @checker_framework.manual Javadoc tag in every checker
# (namely, classes that extend BaseTypeChecker or AggregateChecker) 
# and in every file in a qual/ or compatqual/ subdirectory.
# File files-lacking-cfmanualtag.txt lists the files that violate this goal.
find -path '*/qual/*' -o -path '*/compatqual/*' > 
files-needing-cfmanual-tag-unsorted.txt
find -type f -name '*.java' -print0 | xargs -0 grep -l 'extends 
AggregateChecker\|extends BaseTypeChecker' >> 
files-needing-cfmanual-tag-unsorted.txt
grep '.java$' files-needing-cfmanual-tag-unsorted.txt | grep -v '/tests/' | 
sort | uniq > files-needing-cfmanual-tag.txt
find -type f -name '*.java' -print0 | xargs -0 grep -l 
'@checker_framework.manual' | sort > files-having-cfmanual-tag.txt
diff files-needing-cfmanual-tag.txt files-having-cfmanual-tag.txt | grep '^<' > 
files-lacking-cfmanualtag.txt

Original issue reported on code.google.com by michael.ernst@gmail.com on 3 Mar 2015 at 6:21