cocoon-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Linden H van der (MI)" <H.vanderLin...@MI.unimaas.nl>
Subject RE: generated docs (was: [VOTE] Consensus about documentation location)
Date Mon, 13 Jun 2005 12:46:26 GMT

> yes, the usual javadocs, the page generated out of 
> trunk/lib/jars.xml and the 
> pages generated out of the javadocs of sitemap components. 

To me this is API docs and serve a special purpose. 
_I_ would be perfectly happy if they were in an accessible place, with
links to it from the "ordinary docs", but not part of the docs
themselves. 

> Some auto-generated 
> documentation for Cocoon Forms also makes sense or is IMHO 

Hmm, I'm lost here, what auto-generated documentation for CForms do you
mean? 

> the only chance to keep the docs consistent with the code.

I have thought this too earlier on, but apart from the few exceptions,
most code-writers don't write (good) documentation. This should be
discussed further, but I'm inclined to have programmers write the code
and add enough java docs to explain the reason and usage for the
class/component. A person with more documentation skills can elaborate
this information and add it to the "ordinary" docs.

> Additionally we will have to work out how this relates to the 
> cocoon-refdoc project Bertrand is mentoring.

TDB.

Bye, Helma

Mime
View raw message