Hi,

as noted by david there were some js problems, i removed the js refs 
from the sample pages,
so a second try trigger some discussion about more accurate reference 
documentation.

I try to summarize what I have done, i make a distro available under
http://members.a1.net/berni_huber/ref-docs/index.html .

My idea was not to replace javadoc documentation, but to help writing 
the sitemap, avoiding to go to the java source code,
and to avoid writing too much explicit documentation which is never 
uptodate with the java source code.
That's the whole indention.

Defined cocoon:tags :
@cocoon:name {name} name is  sitemap name of the sitemap componented 
implemented by this class

Proposed cocoon:tags:
@cocoon:deprecated [yes|no]  Used for documenting deprectated sitemap 
components.

More cocoon:tags:
@cocoon:optional [yes|no] describing if it is optional
@cocoon:core [yes|no] describing if its core
@cocoon:input-dtd for transformers describe the expected input 
xml-document-type
@cocoon:output-dtd for transformers, and generators describe the 
expected xml-document-type produced.
@cocoon:objectModel ? describe what is put into the objectmodel map.
...

I'm not quite sure about how detailed the @cocoon: tags should be....


bye bernhard




---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, email: [EMAIL PROTECTED]

Reply via email to