On 03.07.2010 Robin Anil wrote: > Javadoc is the best way to go in terms of versioned documentation. Wiki > pages can link to each version. We haven't enforced package summary nor are > the javadoc comments proofread to check whether they are clear enough for > any developer to understand. So for 1.0 having package summaries and proof > read javadoc should be a blocker. The way I see it, wiki will serve as a > way to ease generation of the doc due to its open nature
Javadocs are fine for more experienced developers. However we do have some "Getting started", "HowTo start individual algorithms" and such in the wiki that would be nice to have for each release. You are right in that the wiki lowers the bar for adding to the documentation, however I think we should at least distribute some overview or getting started with each release. Not sure this can (or even should) be covered in the Javadocs alone. Isabel
signature.asc
Description: This is a digitally signed message part.
