multidoc-jnr

August 21st, 2005 by Hen

I’m always very frustrated by the lack of versioned javadoc at websites. Eric pointed out the other day that he had that pain trying to find the documentation online for the Tapestry 2.x application we have. Partly that shows that I should have it on my lleutranet informal intranet website :)

While cool ideas like Ashkelon exist to handle javadoc in a database, I’m going for something simpler. Put the javadoc into a versioned directory structure, then stick a simple site on top of it. The idea has floated around at Apache for a bit and I now have the energy to try out a prototype at OSJava.

It’s called Multidoc Jnr, after a previous attempt to do the same thing that was just a little bit too heavy to go ahead and use. The url is http://dist.osjava.org/releases/multidoc-jnr/.

  1. Suck doc out of .zip release files
  2. Generate multidoc jnr html pages
  3. Profit

Next steps. Make it a bit smarter on the .zip files; don’t unzip if already unzipped. Fix a couple of releases whose .zips were missing javadoc. Cron it.

Comments are closed.