Re: [Geotools-devel] on-line api

[Martin D. <mar...@te...>]

Hello

> [...] it would be really
> helpful to me if there was some sort of on-line, auto-generated
> (nightly) API documents, similar to those for GeoTools1.

Of course I fully agree!! I have no experience with Ant, but there is my 
proposal for javadoc option:


javadoc -sourcepath {SOURCE_DIRECTORY} -d {DEST_DIRECTORY} 
@gtbuild/javadoc-options.txt

Where "javadoc-options.txt" is a file containing the following:


-quiet
-source 1.4
-nodeprecated
-noqualifier all
-docfilessubdirs

-windowtitle "Geotools 2 API"
-doctitle    "Geotools 2 API"
-header      "Geotools 2 API"
-overview overview.html

-link http://java.sun.com/j2se/1.4/docs/api
-link http://java.sun.com/products/java-media/3D/forDevelopers/j3dapi
-link http://geotools.sourceforge.net/javadoc/opengis

-group "Coordinate Transformation Services (CSS)" 
"org.geotools.pt:org.geotools.cs:org.geotools.ct"
-group "Grid Coverages Services (GCS)" 
"org.geotools.cv:org.geotools.gc:org.geotools.gp"
-group "Utilities" 
"org.geotools.io:org.geotools.util:org.geotools.units"

-subpackages org.geotools
-exclude     org.geotools.resources




-------------------------------------------------

In the example above, "http://geotools.sourceforge.net/javadoc/opengis" 
should point to some place in the Geotools 2 with the OpenGIS JavaDoc, 
and "overview.html" should be some file somewhere giving an overview of 
the whole Geotools 2 project.

There is more "-group" options to add for other modules too.


	Martin.