Mailing-List: contact java-dev-help@lucene.apache.org; run by ezmlm
Precedence: bulk
Reply-To: java-dev@lucene.apache.org
Received-SPF: pass (athena.apache.org: domain of rcmuir@gmail.com designates
 209.85.132.242 as permitted sender)
DomainKey-Signature: a=rsa-sha1; c=nofws;
        d=gmail.com; s=gamma;
        h=mime-version:in-reply-to:references:date:message-id:subject:from:to
         :content-type:content-transfer-encoding;
        b=t+fjtrhF5oE3Aiy+64ImKF5BYaXzIIz6V7N55vD2sdVwld2uUAsVP9RSGuPmt7kv2g
         Iic5IpELOq5b1WmYJDBtQVOGZvi48vlfh1WHp4eYkEKUruEFu3CmmB/xOaJULd3NrxGq
         UqpVvqqrYqe7gNzmFM0H5yq8LDmcQ7tumIzRY=
MIME-Version: 1.0
In-Reply-To: <Pine.LNX.4.64.0908181721170.16209@radix.cryptio.net>
References: <Pine.LNX.4.64.0908181721170.16209@radix.cryptio.net>
Date: Tue, 18 Aug 2009 20:44:55 -0400
Message-ID: <8f0ad1f30908181744t79e09464vef2083cec1b42614@mail.gmail.com>
Subject: Re: Cleaning up Javadoc warnings in contribs
From: Robert Muir <rcmuir@gmail.com>
To: java-dev@lucene.apache.org
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: quoted-printable

the scary number for analyzers might be a bit out of date. (hopefully
most of) these were cleaned up with the contrib/analysis javadocs+test
patch this morning.

On Tue, Aug 18, 2009 at 8:34 PM, Chris
Hostetter<hossman_lucene@fucit.org> wrote:
>
> As a general rule: if the javadoc command generates a warning, it's a pre=
tty
> 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. =C2=A0It would b=
e great
> if each of the various defacto "contrib maintainers" (you know who you ar=
e)
> 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
> =C2=A0 =C2=A0 96 analyzers
> =C2=A0 =C2=A0 32 benchmark
> =C2=A0 =C2=A0 52 collation
> =C2=A0 =C2=A0 =C2=A08 db
> =C2=A0 =C2=A0 32 fast-vector-highlighter
> =C2=A0 =C2=A0 32 highlighter
> =C2=A0 =C2=A0 24 memory
> =C2=A0 =C2=A0 40 queryparser
> =C2=A0 =C2=A0 =C2=A08 regex
> =C2=A0 =C2=A0 52 remote
> =C2=A0 =C2=A0 =C2=A08 snowball
> =C2=A0 =C2=A0 =C2=A08 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
>
>


--=20
Robert Muir
rcmuir@gmail.com

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