cocoon-docs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Bertrand Delacretaz <bdelacre...@codeconsult.ch>
Subject Re: Documentation Format...
Date Wed, 20 Nov 2002 10:12:24 GMT
On Tuesday 19 November 2002 18:12, Andy Lewis wrote:
>. . .
> I agree that DEVELOPER documentation should be in the source files. But not
> user documentation....

same here. The killer argument is that you don't want non-programmers to make 
changes to java source files because they're changing the *user 
documentation* of the component.

Also, a component might (often should ;-) be written in multiple java source 
files, in which case having a separate XML doc file for the component as a 
whole makes it clear where the documentation is.

-Bertrand

Mime
View raw message