[
https://issues.apache.org/jira/browse/LUCENE-4324?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Robert Muir updated LUCENE-4324:
--------------------------------
Attachment: LUCENE-4324_crawl.patch
the start to the patch that just crawls classes. Whenever we find a
package.html, we know any files (except package-xxx) in that same directory are
also Classes/Interfaces/Enums/Annotations that we should check.
We just need the logic to check them!
> extend checkJavaDocs.py to methods,constants,fields
> ---------------------------------------------------
>
> Key: LUCENE-4324
> URL: https://issues.apache.org/jira/browse/LUCENE-4324
> Project: Lucene - Core
> Issue Type: New Feature
> Components: general/build
> Reporter: Robert Muir
> Attachments: LUCENE-4324_crawl.patch
>
>
> We have a large amount of classes in the source code, its nice that we have
> checkJavaDocs.py to ensure packages and classes have some human-level
> description.
> But I think we need it for methods etc too. (it is also part of our
> contribution/style guidelines:
> http://wiki.apache.org/lucene-java/HowToContribute#Making_Changes)
> The reason is that like classes and packages, once we can enforce this in the
> build, people will quickly add forgotten documentation soon after their
> commit when its fresh in their mind.
> Otherwise, its likely to never happen.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
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]
