> My company has been working on a web-based system that will
> automatically generate JavaDocs (and other documentation based on the
> source code) out of CVS.  I don't know how quickly you plan to get the
> new site generated, but I wanted to share what we've done and see if the
> James project wanted to rely on it for the up-to-date javadoc release.
> It's not quite ready for prime time (we're still tweaking the output and
> need to add security settings), but hopefully next week I can send a
> link to everyone to see what it outputs.

That sounds cool.

My one reservation is that as our docs *are* generated and versioned we have
a (managerial) problem with version control of the docs published on the
website.

As it is strictly *not* necessary to make them available on the website and
we provide them there for convenience only it makes sense to not to hog
resources by maintaining several versions, and therefore to follow the
"principle of least suprise" we should be publishing the javadocs for the
current stable version. This means that they will have to lag behind cvs.

My first thought is that the simplest way to achieve this is to have the
release manager for any stable release simply copy the docs generated by the
same build that generates the downloads and commit them to the site cvs.
Then we _know_ that they match the download version and that they can't
easily be changed by accident.

I look forward to seeing what your tool does though, perhaps it will
facilitate a new behaviour we can make use of.



Reply via email to