lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Michael Busch <busch...@gmail.com>
Subject Re: Cleaning up Javadoc warnings in contribs
Date Wed, 19 Aug 2009 01:00:13 GMT
On 8/18/09 5:34 PM, Chris Hostetter wrote:
>
> As a general rule: if the javadoc command generates a warning, it's a 
> pretty good indication that the resulting javadocs aren't going to 
> look the way you expect. (there may be lots of places where the 
> javadocs look wrong and no warning is logged -- but the reverse is 
> almost never true)
>
> The other day, I went through all of the warnings produced by "ant 
> javadocs-core" and fixed the offending javadoc comments.  It would be 
> great if each of the various defacto "contrib maintainers" (you know 
> who you are) could take a look at the warnings produced by each of the 
> contribs.

+1. Good task for the upcoming 2.9 code freeze period!

  Michael

>
> They're pretty easy to spot if you grep the raw console output from 
> the nightly builds for "[javadoc]" and "warning" ...
>
> hossman@coaster:~$ curl -s 
> http://hudson.zones.apache.org/hudson/job/Lucene-trunk/922/consoleText 
> | grep "[javadoc]" | grep "warning" | perl -nle 'print $1 if 
> m{contrib/([^/]*)/}' | sort | uniq -c
>      96 analyzers
>      32 benchmark
>      52 collation
>       8 db
>      32 fast-vector-highlighter
>      32 highlighter
>      24 memory
>      40 queryparser
>       8 regex
>      52 remote
>       8 snowball
>       8 xml-query-parser
>
>
>
>
>
> -Hoss
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
> For additional commands, e-mail: java-dev-help@lucene.apache.org
>
>


---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org


Mime
View raw message