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

Robert Muir commented on LUCENE-4324:
-------------------------------------

I think this is working pretty well now as far as output. also the overridden 
method situation
mentioned by Uwe is resolved, and Mike has it detecting more broken html.

I think we should port to java6 now before it gets any harder. If no one beats 
me to it I'll
try to look at this later tonight (but please feel free, otherwise I will be 
hacking on trying
to fill in missing docs themselves)
                
> 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]

Reply via email to