[LUCENE-4797] Fix remaining Lucene/Solr Javadocs issue

• Type: Bug
• Status: Patch Available
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 4.1
• Fix Version/s: 5.1, 6.0
• Component/s: general/javadocs
• Labels: Java8
• Lucene Fields: New
• Assignee: Uwe Schindler
• Reporter: Uwe Schindler
• Created: 25/Feb/13 19:19
• Updated: 24/Nov/24 06:01
• Resolved: 09/Feb/15 19:12

Description

Java 8 has a new feature (enabled by default): http://openjdk.java.net/jeps/172

It fails the build on:

• incorrect links (@see, @link,...)
• incorrect HTML entities
• invalid HTML in general

Thanks to our linter written in HTMLTidy and Python, most of the bugs are already solved in our source code, but the Oracle Linter finds some more problems, our linter does not:

• missing escapes <
• invalid entities

Unfortunately the versions of JDK8 released up to today have a bug, making optional closing tags (which are valid HTML4), like </p>, mandatory. This will be fixed in b78.

Currently there is another bug in the Oracle javadocs tool (it fails to copy doc-files folders), but this is under investigation at the moment.

We should clean up our javadocs, so the pass the new JDK8 javadocs tool with build 78+. Maybe we can put our own linter out of service, once we rely on Java 8

Issue Links

• is related to: LUCENE-4808 Add workaround for a JDK 8 "class library bug" which is still under discussion and may *not* be fixed