cocoon-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Carsten Ziegeler" <>
Subject RE: [RT] Generating docs and entries for sitemap component from JavaDocs
Date Tue, 04 May 2004 06:59:48 GMT
Sylvain Wallez wrote:
> >The general idea is to use some javadoc tags, like 
> @cocoon.something to 
> >specify sitemap components (their name, perhaps the logger category 
> >etc.) and generate the sitemap entries from this.
> >In addition the JavaDoc for the class will be converted into the XML 
> >doc file for that component (and added to the index etc.)
> >  
> >
> I'm ok with this approach for *reference* documentation, as 
> this effort often has to be duplicated between the javadoc 
> and the xdocs. But this isn't IMO suitable for introductory 
> material, which needs to be more verbose that what we can 
> reasonably put in a Java file, and because of the 
> hierarchical/alphabetical navigation structure docs extracted 
> from code will produce.
Sure, yes, I wasn't wery clear in my mail: I only want to generate
reference docs - nothing more.


View raw message