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

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:

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

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: 
http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4464323.

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: https://issues.apache.org/jira/browse/LUCENE-3006
>             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 
> http://www.lucidimagination.com/search/document/14bd01e519f39aff/brainstorming_on_improving_the_release_process

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

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

Reply via email to