[jira] [Commented] (LUCENE-3006) Javadocs warnings should fail the build
[ https://issues.apache.org/jira/browse/LUCENE-3006?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13014767#comment-13014767 ] Steven Rowe commented on LUCENE-3006: - bq. Patch annihilating modules/ javadoc warnings (in analysis/icu/ and benchmark/). Committed on trunk r1087830. > 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-javadoc-warning-cleanup.patch, > LUCENE-3006-modules-javadoc-warning-cleanup.patch, LUCENE-3006.patch, > 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
[jira] [Commented] (LUCENE-3006) Javadocs warnings should fail the build
[ https://issues.apache.org/jira/browse/LUCENE-3006?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13014011#comment-13014011 ] Steven Rowe commented on LUCENE-3006: - bq. This patch eliminates javadoc warnings on trunk under Sun JDK 1.5.0_22 and 1.6.0_21 for Lucene, and for just 1.6.0_21 on Solr. Committed: - r1087319: trunk - r1087329: branch_3x On branch_3x, under both Sun JDK 1.5.0_22 and 1.6.0_21, there are no javadoc warnings for either Solr or Lucene. > 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-javadoc-warning-cleanup.patch, > 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
[jira] [Commented] (LUCENE-3006) Javadocs warnings should fail the build
[
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
[jira] [Commented] (LUCENE-3006) Javadocs warnings should fail the build
[ https://issues.apache.org/jira/browse/LUCENE-3006?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13013678#comment-13013678 ] Grant Ingersoll commented on LUCENE-3006: - I think this is ready to go, but still want to test to make sure contribs are building correctly. Also, committing it will break the build, as we have warnings on trunk! > 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
[jira] [Commented] (LUCENE-3006) Javadocs warnings should fail the build
[ https://issues.apache.org/jira/browse/LUCENE-3006?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13013548#comment-13013548 ] Yonik Seeley commented on LUCENE-3006: -- bq. We should fail the build when there are javadocs warnings Hopefully you mean the build of javadoc should fail? It seems like one should be able to do a quick change of a method to try something out and still be able to do "ant test" to see if it works w/o having to go fix all javadoc references to it first? > 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 > > 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
[jira] [Commented] (LUCENE-3006) Javadocs warnings should fail the build
[ https://issues.apache.org/jira/browse/LUCENE-3006?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13013544#comment-13013544 ] Steven Rowe commented on LUCENE-3006: - Doron Cohen briefly enabled fail-on-javadocs-warnings a few years back: https://issues.apache.org/jira/browse/LUCENE-875?focusedCommentId=12493779&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-12493779 > 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 > > 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
[jira] [Commented] (LUCENE-3006) Javadocs warnings should fail the build
[ https://issues.apache.org/jira/browse/LUCENE-3006?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13013540#comment-13013540 ] Yonik Seeley commented on LUCENE-3006: -- One nit - javadocs for solr are not nearly as important as javadocs for lucene in general, and are often just there for expert / internal developers. But I don't know how onerous it will be to fail on jdoc warning yet... maybe it won't be a big deal. > 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 > > 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
[jira] [Commented] (LUCENE-3006) Javadocs warnings should fail the build
[ https://issues.apache.org/jira/browse/LUCENE-3006?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13013530#comment-13013530 ] Michael McCandless commented on LUCENE-3006: +1 > 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 > > 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
