Sylvain Wallez wrote:
Joerg Heinicke wrote:
On 03.05.2004 18:53, Sylvain Wallez wrote:
Question : why do we need to add components from blocks in
the main
sitemap? We could just declare them in their respective samples
sitemap...
Other blocks can not use these components.
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
I just finished the first version of the documentation task.
It generates documentation and sitemap entries from some
java doc tags and merges the existing documentation into
the generated one. In addition it takes some information
out of the Java Source, like if the class implements logging etc.
Carsten Ziegeler wrote:
Have a look, comment and - most important - improve it!
BUILD FAILED
C:\cocoon-2.1\tools\targets\webapp-build.xml:93: Following error occured
while executing this line
C:\cocoon-2.1\build\cocoon-2.1.5-dev\temp\blocks-build.xml:1200: DocDir
should test a little bit with everything and
perhaps disable the generation for the 2.1.5 release.
Carsten
-Original Message-
From: Vadim Gritsenko [mailto:[EMAIL PROTECTED]
Sent: Monday, May 03, 2004 3:49 PM
To: [EMAIL PROTECTED]
Subject: Re: [RT] Generating docs and entries
Late answer, but hey, better than nothing!
Carsten Ziegeler wrote:
I think we discussed this and I think to remember that the
general opinion has been pro the following.
I think we should start generating the user docs for sitemap
components from the java docs. Currently these are separate
On 03.05.2004 18:53, Sylvain Wallez wrote:
Question : why do we need to add components from blocks in the main
sitemap? We could just declare them in their respective samples sitemap...
Other blocks can not use these components. These blocks would need to
get the component declarations from
Carsten Ziegeler wrote:
...
I think we should just start with something (even if we throw
it away later on) and improve it.
+1
Since many projects using Forrest use or are planning to use javadoc
tags to generate documentation, I was musing about doing it in the
future in Forrest, so I'm going
I think we discussed this and I think to remember that the
general opinion has been pro the following.
I think we should start generating the user docs for sitemap
components from the java docs. Currently these are separate
things which leads to
- user doc is not updated when the component
Carsten Ziegeler 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
Bertrand Delacretaz wrote:
...
Yes, *do* is the key here.
Go, Carsten, go!
Hint1: it would be cool if we could put these in Forrest.
Hint2: Why not use the qdox generator that comes in its block?
This could make the docs be integrated with Forrest docs,
and one doesn't need to
-Original Message-
From: news [mailto:[EMAIL PROTECTED] On Behalf Of Nicola Ken Barozzi
Sent: Thursday, April 29, 2004 5:09 PM
To: [EMAIL PROTECTED]
Subject: Re: [RT] Generating docs and entries for sitemap
component from JavaDocs
Bertrand Delacretaz wrote:
...
Yes, *do
Carsten Ziegeler wrote:
Tony Collen wrote:
As I said, I'm leery of embedding a bunch of user-guide type
material into the Javadocs, but I would be more comfortable
if it was used as more of a technical reference than
anything. Maybe a quick one or two-paragraph description of
how the
13 matches
Mail list logo
