[
https://issues.apache.org/jira/browse/LUCENE-4324?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13442796#comment-13442796
]
Robert Muir commented on LUCENE-4324:
-------------------------------------
Thanks Mike! Some comments:
{noformat}
- if lineLower.startswith('package ') or lineLower.startswith('<h1
title="package" '):
+ if lineLower.startswith('package ') or \
+ lineLower.startswith('<h1 title="package" ') or \
+ lineLower.startswith('class ') or \
+ lineLower.startswith('<h1 title="class" ') or \
+ lineLower.startswith('interface ') or \
+ lineLower.startswith('<h1 title="interface" ') or \
+ lineLower.startswith('enum ') or \
+ lineLower.startswith('<h1 title="enum" ') or \
+ lineLower.startswith('annotation type ') or \
+ lineLower.startswith('<h1 title="annotation" '):
sawPackage = True
{noformat}
I think that piece is unnecessary?
Also I think we should add a comment TODO: java6 support. it currently passes
for java6! but works great for java7~!
> 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-4322.patch, 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]
