Bruno Dumon said the following on 20-03-2006 11:58:
The intention is to tag the classes, and to write longer, user-oriented
documentation on it in Daisy. For this the legacy docs, javadoc, wiki
and mailing list archives can be used as inspiration.
If you want to help out, but don't necessarily know much about all these
components, a first and very helpful step would be to add the javadoc
tags.
If you look at e.g. I18nTransformer.java, you'll see the tags are at the
top, and the normal javadoc text at the bottom, which breaks the javadoc
generation:
http://cocoon.apache.org/2.1/apidocs/org/apache/cocoon/transformation/I18nTransformer.html
(it thinks the text is all part of the @c.s.c.logger annotation).
So after this is done, each component ends up with:
- a javadoc file
- a summary (using this tool) in Daisy
- a Daisy page with user oriented info
Is this correct?
Note that I'm running this tool on trunk, so any updates will only have
effect when committed over there.
Good to know. ;-)
Bye, Helma
