lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Robert Muir (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (LUCENE-4797) Fix remaining Lucene/Solr Javadocs issue
Date Fri, 28 Nov 2014 03:58:12 GMT

    [ https://issues.apache.org/jira/browse/LUCENE-4797?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14228065#comment-14228065
] 

Robert Muir commented on LUCENE-4797:
-------------------------------------

I made some progress on many of the silly issues. but we have to disable some checks:

{code}
-Xdoclint:all -Xdoclint:-html -Xdoclint:-missing
{code}

To enable html, we have to fix the stuff Uwe describes here. To enable missing, we have to
add missing param/return/throws/everything. But we at least reject totally broken stuff, and
the linter is *FAST*

> 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
>              Labels: Java8
>
> 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.3.4#6332)

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org


Mime
View raw message