Hi Dan,
I think creating the distibution for javadocs is a very right thing. What do
you think about going further
and providing it as yet another CXF downloadable (like sources for example)? So
the main distribution will
stay small but people may download the javadocs as well if they will. My
assumption is that most of the
people google javadocs online.
Best Regards,
Andriy Redko
DK> For 2.x, we basically generated 2 different sets of Javadoc for 2 different
purposes:
DK> 1) We generated the javadoc ONLY for the cxf-api. This is the javadoc that
we stuck in the “docs” dir of the distribution.
DK> 2) As part of the big cxf-bundle build, we generated javadocs for
everything that went in the bundle. This is what we deployed to the website.
DK> There are some problems with both…. cxf-api misses a ton of stuff that we
expect users to use. Things like the
DK> HttpConduits for configuring http settings, lots of JAX-RS things, the
JAX-WS factories, etc…. The second one
DK> includes a lot more stuff, but still misses anything in the services (sts,
ws-discovery, etc…). Plus, those are just available on-line. Not sure if
that’s an issue.
DK> For 3.0, we want to get rid of the big bundle. Thus, generating 2 needed a
re-think. I just pushed some changes
DK> to create a distribution/javadoc module to handle that. It now includes
EVERYTHING other than the wars and tests.
DK> Thus, it really is a complete javadoc of everything in CXF.
DK> Now, the question comes: what do we want to include and where? The full
javadoc is 168MB. Do we want to include
DK> that in the distribution? (although it compresses very very well so
doesn’t balloon the tar.gz/zip up by much). Or
DK> do we want to include only some subset for the distribution? Just
“cxf-core” to match what we included for 2.x?
DK> More? Alternatively, in the docs dir, just put a simple read me that
points to cxf.apache.org/docs for the main
DK> docs and the appropriate javadoc dir for javadoc? That may be the most
appropriate since we don’t include any
DK> “real” docs in the distribution anyway, just the javadocs.
DK> Thoughts?
