Commit Graph

30 Commits

Author SHA1 Message Date
Robert Muir 69f26d099e
LUCENE-9213: fix documentation-lint (and finally precommit) to work on java 12 and 13
the "missing javadocs" checker needed tweaks to work with the format
changes of java 13.

As a followup we may investigate javadoc (maybe the new doclet api). It
has its own missing checks too now, but they are black vs white (either
fully documented or not checked), whereas this python tool allows us to
"improve", e.g. enforce that all classes have doc, even if all
methods do not yet.
2020-02-07 17:18:26 -05:00
Uwe Schindler faaee86efb LUCENE-8738: Move to Java 11 as minimum Java version (merged branch: jira/LUCENE-8738)
Co-authored-by: Adrien Grand <jpountz@apache.org>
2019-04-16 14:00:09 +02:00
Ishan Chattopadhyaya cb97ad787a SOLR-10004: Making the description of the failure more clear 2017-05-29 22:54:26 +05:30
Steve Rowe 78ed1ca879 LUCENE-7308: checkJavaDocs.py (called from documentation-lint): checkClassDetails(): reimplement detail item chunking to align with actual item boundaries, and to test the final item. 2016-06-01 13:39:07 -04:00
Michael McCandless a886c663d3 LUCENE-6675: improve spatial3d javadocs
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1690784 13f79535-47bb-0310-9956-ffa450edef68
2015-07-13 18:10:56 +00:00
Michael McCandless 9e6353843c fix smoke tester to pass again
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1682481 13f79535-47bb-0310-9956-ffa450edef68
2015-05-29 14:17:04 +00:00
Michael McCandless 68b6d00cba fix missing javadocs checker to work with Java 1.8 generated javadocs too
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1657805 13f79535-47bb-0310-9956-ffa450edef68
2015-02-06 13:37:07 +00:00
Michael McCandless 3941b3f266 handle default annotations; remove workaround for now fixed javadoc bug
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1654004 13f79535-47bb-0310-9956-ffa450edef68
2015-01-22 18:53:21 +00:00
Michael McCandless 73ec0f28cc improve error reporting when this tool finds javadocs problems
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1629157 13f79535-47bb-0310-9956-ffa450edef68
2014-10-03 09:20:09 +00:00
Michael McCandless 36edbb84ea unescape %20 in urls so we don't get false failures with 1.7.0_60
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1575328 13f79535-47bb-0310-9956-ffa450edef68
2014-03-07 17:09:27 +00:00
Michael McCandless 36d7c6b38d try to workaround javadocs bug causing nightly-smoke to fail
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1522885 13f79535-47bb-0310-9956-ffa450edef68
2013-09-13 11:58:33 +00:00
Robert Muir a4ea891571 add level=none option so we can find more broken html in solr javadocs
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1383047 13f79535-47bb-0310-9956-ffa450edef68
2012-09-10 19:00:45 +00:00
Robert Muir 45d6f0edc0 LUCENE-4324: enable broken html detection
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1378541 13f79535-47bb-0310-9956-ffa450edef68
2012-08-29 13:29:48 +00:00
Michael McCandless 1fb282a4cb fix MemoryIndex false positive failure
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1378271 13f79535-47bb-0310-9956-ffa450edef68
2012-08-28 19:03:42 +00:00
Michael McCandless 18fe854d86 detect broken HTML in the detailed class javadocs
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1378252 13f79535-47bb-0310-9956-ffa450edef68
2012-08-28 18:14:07 +00:00
Michael McCandless 2684ba035e try to catch mis-matched tags in the desc
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1378143 13f79535-47bb-0310-9956-ffa450edef68
2012-08-28 14:08:01 +00:00
Robert Muir d3a9eeee06 clean up regexps
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1378107 13f79535-47bb-0310-9956-ffa450edef68
2012-08-28 12:36:00 +00:00
Robert Muir ed8adb5e92 generics-proof this
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1377970 13f79535-47bb-0310-9956-ffa450edef68
2012-08-28 04:05:33 +00:00
Robert Muir 182d59b75e prune overridden methods
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1377966 13f79535-47bb-0310-9956-ffa450edef68
2012-08-28 03:47:47 +00:00
Robert Muir 5e2be08e77 build up a list so we can prune overridden methods
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1377958 13f79535-47bb-0310-9956-ffa450edef68
2012-08-28 03:20:37 +00:00
Robert Muir e82f5c2862 avoid false positives in regexes, and parse nested classes correctly
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1377953 13f79535-47bb-0310-9956-ffa450edef68
2012-08-28 02:53:39 +00:00
Robert Muir b4ca62c640 don't parse incomplete ctor specification
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1377949 13f79535-47bb-0310-9956-ffa450edef68
2012-08-28 02:32:51 +00:00
Robert Muir 2ea9eec086 don't parse incomplete method specification
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1377945 13f79535-47bb-0310-9956-ffa450edef68
2012-08-28 02:18:58 +00:00
Michael McCandless ce82983b6b LUCENE-4324: initial cut at method/field level javadocs checking
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1377911 13f79535-47bb-0310-9956-ffa450edef68
2012-08-27 23:23:25 +00:00
Uwe Schindler f600aa6094 fix encoding in javadocs checker
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1367120 13f79535-47bb-0310-9956-ffa450edef68
2012-07-30 15:31:45 +00:00
Michael McCandless e101167585 upgrade checkJavaDocs.py to python3
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1367071 13f79535-47bb-0310-9956-ffa450edef68
2012-07-30 12:49:40 +00:00
Robert Muir a762414610 harden checkJavaDocs.py: java7 writes extra newlines/divs before the class summary
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1332675 13f79535-47bb-0310-9956-ffa450edef68
2012-05-01 14:46:20 +00:00
Robert Muir 7329e7e9d1 detect and fail when class javadocs is really just the license header
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1331787 13f79535-47bb-0310-9956-ffa450edef68
2012-04-28 15:39:41 +00:00
Robert Muir dc4f912cfa LUCENE-3887: add macro for checking missing javadocs, add some missing package.html javadocs
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1329423 13f79535-47bb-0310-9956-ffa450edef68
2012-04-23 20:19:01 +00:00
Michael McCandless aa8cfa0d12 LUCENE-3887: fix smoke tester to fail when package.html is missing or public classes don't have description in package-summary
git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1303830 13f79535-47bb-0310-9956-ffa450edef68
2012-03-22 15:24:44 +00:00