[
https://issues.apache.org/jira/browse/LUCENE-6224?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14310339#comment-14310339
]
Robert Muir commented on LUCENE-6224:
-------------------------------------
The change seems to work with java 7 too. I'll convert the remaining
package.htmls and fix any doclint complaints about them.
Temporarily, precommit will be a bit slower because of the hack i applied to
.ecj (it will be writing classfiles to a trash directory). But we need to make
the step (along with others like turning on real html linting in doclint) to
ultimately remove things like ecj, jtidy, python checks which will make it much
faster in the end.
> move package.htmls to package-info.java for better tooling support
> ------------------------------------------------------------------
>
> Key: LUCENE-6224
> URL: https://issues.apache.org/jira/browse/LUCENE-6224
> Project: Lucene - Core
> Issue Type: Task
> Reporter: Robert Muir
>
> Today, on java8, if you typo a link in the package documentation of
> org.apache.lucene.search (package.html) like this:
> {code}
> {@link org.apache.lucene.search.TermQueryX TermQuery}
> {code}
> then javadoc will silently do the wrong thing, it will generate a
> <code>xxx</code> block with no link at all.
> On the other hand, if instead we do it as package-info.java, then it shows up
> in big red letters as an error in my IDE, doclint catches it at compile time,
> etc, and we ensure our links are doing what we want.
> {code}
> [javac]
> /home/rmuir/workspace/trunk/lucene/core/src/java/org/apache/lucene/search/package-info.java:75:
> error: reference not found
> [javac] {@link org.apache.lucene.search.TermQueryX TermQuery}
> {code}
> I think we should cutover? this also helps us rely less on our own linting
> scripts long term because now doclint is checking these files too.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
