Adrian Custer a écrit :
I'm discovering that things like
org.geotools.factory.FactoryRegistry
and
org.geotools.resources*
are really meant as internal resources for the library, not for users of
the library.
org.geotools.resources.* is really flagged as internal ressources since the beginning of Geotools.
The package javadoc warns users to avoid this package, and this package should clearly be excluded
from javadoc. Indeed, it is excluded when using the Ant script that I wrote for javadoc generation.
org.geotools.factory.FactoryRegistry was made available for public use, but we could revisit that if
it is causing confusion. But org.geotools.factory.FactoryRegistry is an extension of
javax.imageio.spi.ServiceRegistry, which is a public and commited class from J2SE 1.4. While it may
have a (too?) complex internal mechanic, it should be easy to use for implementors of FactoryFinders
(e.g. org.geotools.referencing.FactoryFinder).
Is there a clear distinction between the API which should be used by
third party users of the library and the API available to geotool
developers (whats in the javadocs)?
Everything in org.geotools.resources is for internal mechanic only. Everything else is for public
use, unless otherwise stated by package javadoc. However, I realize that some classes outside
org.geotools.resources should probably have been made package-privated instead of public.
But maybe i'm simply confused or perhaps this is a jira issue?
A JIRA issue is probably worth. In a near future, I'm putting some hope on the improved Javadoc tool
to be bundled in J2SE 1.6 (while we are still commited to J2SE 1.4, nothing prevent us from using
whatever tools we want for javadoc generation). The next javadoc tools may provide us with some
annotation for classifying methods as "basic" or "advanced" for example. See the prototype there:
http://java.sun.com/j2se/javadoc/6/JFrame.html#method_summary
Martin.
-------------------------------------------------------
Using Tomcat but need to do more? Need to support web services, security?
Get stuff done quickly with pre-integrated technology to make your job easier
Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
http://sel.as-us.falkag.net/sel?cmd=lnk&kid0709&bid&3057&dat1642
_______________________________________________
Geotools-devel mailing list
Geotools-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/geotools-devel
