lucene/dev-tools
Robert Muir 784ede4eda
LUCENE-9215: replace checkJavaDocs.py with doclet (#1802)
This has the same logic as the previous python, but no longer relies
upon parsing HTML output, instead using java's doclet processor.

The errors are reported like "normal" javadoc errors with source file
name and line number and happen when running "gradlew javadoc"

Although the "rules" are the same as the previous python, the python had
some bugs where the checker didn't quite do exactly what we wanted, so
some fixes were applied throughout.

Co-authored-by: Dawid Weiss <dawid.weiss@carrotsearch.com>
Co-authored-by: Uwe Schindler <uschindler@apache.org>
2020-09-02 08:29:17 -04:00
..
2020-09-01 09:08:05 +02:00

The tools, documentation, etc. in this directory are intended to be helpful
to developers of Lucene and Solr.  They are not necessarily maintained in
the same way that the core code is maintained and so your mileage may vary
as to the usefulness of the tools.

Description of dev-tools/ contents:

./size-estimator-lucene-solr.xls -- Spreadsheet for estimating memory and disk usage in Lucene/Solr
./missing-doclet -- JavaDoc validation doclet subproject
./doap/       -- Lucene and Solr project descriptors in DOAP RDF format.
./scripts/    -- Odds and ends for building releases, etc.
./test-patch/ -- Scripts for automatically validating patches