Re: [Geotools-devel] When Maven fails to generate javadoc: TIPS!

[Andrea A. <aa...@op...>]

Martin Desruisseaux ha scritto:
> I though that it was mysterious "caprice" from Maven, but actually the reason is
> quite simple.
> 
> Javadoc has "warnings" and "errors". Only "errors" stop the build. Our problem
> is that Geotools javadoc is quite bad, with full of warnings. So it is hard to
> spot the little javadoc fatal error in our hundred of warnings.
> 
> If Maven fails to generate javadoc, just run the following on a unix machine:
> 
> mvn javadoc:javadoc | grep "error"
> 
> We get a much smaller output (just about 5 lines!). So with trunk at revision
> 25419, we can spot immediately:
> 
> modules/library/referencing/src/main/java/org/geotools/referencing/factory/epsg/package.html:
> error - Close body tag missing from HTML file
> 
> Adding the missing </BODY> tag fix javadoc generation. It is that simple :)
> 
> I added a note at the bottom of this page:
> 
> http://docs.codehaus.org/display/GEOT/2.6+Generating+Javadoc

Triple doh! Is there any way to avoid seeing warnings?
Oh, this is a valuable tip for the release guide as well.

Thank a lot for sharing!
Cheers
Andrea