You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Uwe Schindler (JIRA)" <ji...@apache.org> on 2014/02/01 19:04:09 UTC
[jira] [Commented] (LUCENE-4797) Fix remaining Lucene/Solr Javadocs
issue
[ https://issues.apache.org/jira/browse/LUCENE-4797?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13888662#comment-13888662 ]
Uwe Schindler commented on LUCENE-4797:
---------------------------------------
FYI, we reenabled Java 8 builds, so the javadocs produced by Java 8 pass our own JTidy/python doclinter. But we disabled Java8's own doclint. We should work now towards making the HTML clean and pure HTML4 (no XHTML, which is disallowed by Java! So no {{<br/>}})
> Fix remaining Lucene/Solr Javadocs issue
> ----------------------------------------
>
> Key: LUCENE-4797
> URL: https://issues.apache.org/jira/browse/LUCENE-4797
> Project: Lucene - Core
> Issue Type: Bug
> Components: general/javadocs
> Affects Versions: 4.1
> Reporter: Uwe Schindler
> Assignee: Uwe Schindler
>
> 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 :-)
--
This message was sent by Atlassian JIRA
(v6.1.5#6160)
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org