[
https://issues.apache.org/jira/browse/LUCENE-3887?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13233604#comment-13233604
]
Christian Moen commented on LUCENE-3887:
----------------------------------------
Robert,
I should be careful recommending things I haven't tried, but perhaps Checkstyle
(http://checkstyle.sourceforge.net/) could be useful for this. The javadoc
package check described on
http://checkstyle.sourceforge.net/config_javadoc.html seems to cover this sort
of style check.
Checkstyle also integrates with build tools so it's also possible to do some
light style checking as part of the build -- either optional or integrated
longer term, if we'd like that. (I'm sure there are various opinions on wether
this is a good idea.)
> 'ant javadocs' should fail if a package is missing a package.html
> -----------------------------------------------------------------
>
> Key: LUCENE-3887
> URL: https://issues.apache.org/jira/browse/LUCENE-3887
> Project: Lucene - Java
> Issue Type: Task
> Components: general/build
> Reporter: Robert Muir
>
> While reviewing the javadocs I noticed many packages are missing a basic
> package.html.
> For 3.x I committed some package.html files where they were missing (I will
> port forward to trunk).
> I think all packages should have this... really all public/protected
> classes/methods/constants,
> but this would be a good step.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:
https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
