Mailing-List: contact java-dev-help@lucene.apache.org; run by ezmlm
Precedence: bulk
Reply-To: java-dev@lucene.apache.org
Received-SPF: pass (nike.apache.org: local policy)
Date: Tue, 18 Aug 2009 17:34:07 -0700 (PDT)
From: Chris Hostetter <hossman_lucene@fucit.org>
To: Lucene Dev <java-dev@lucene.apache.org>
Subject: Cleaning up Javadoc warnings in contribs
Message-ID: <Pine.LNX.4.64.0908181721170.16209@radix.cryptio.net>
MIME-Version: 1.0
Content-Type: TEXT/PLAIN; charset=US-ASCII; format=flowed


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.

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