lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Steven Rowe (JIRA)" <>
Subject [jira] [Commented] (LUCENE-3006) Javadocs warnings should fail the build
Date Thu, 31 Mar 2011 00:09:05 GMT


Steven Rowe commented on LUCENE-3006:

I'm working on cleaning up javadoc warnings on trunk, and found a longstanding Sun javadoc
bug that is hit by the javadoc on the {{FieldInfos}} no-arg constructor:

  * ...
  * Note: this ctor should not be used during indexing use
  * {@link FieldInfos#FieldInfos(FieldInfos)} or
  * {@link FieldInfos#FieldInfos(FieldNumberBiMap)} instead.

Javadoc complains that it can't find the second linked-to constructor.  

There are two problems: first, there really is no constructor with that prototype - it should
have a second parameter of type {{SegmentCodecsBuilder}}; and second, adding the {{SegmentCodecsBuilder}}
parameter doesn't make the warning go away, because of this bug:

Spelling out the {{SegmentCodecsBuilder}} parameter's full package works around this bug under
both Oracle JDK 1.5_0_22 and 1.6.0_21.

> Javadocs warnings should fail the build
> ---------------------------------------
>                 Key: LUCENE-3006
>                 URL:
>             Project: Lucene - Java
>          Issue Type: Improvement
>    Affects Versions: 3.2, 4.0
>            Reporter: Grant Ingersoll
>         Attachments: LUCENE-3006.patch, LUCENE-3006.patch
> We should fail the build when there are javadocs warnings, as this should not be the
Release Manager's job to fix all at once right before the release.
> See

This message is automatically generated by JIRA.
For more information on JIRA, see:

To unsubscribe, e-mail:
For additional commands, e-mail:

View raw message