#19 Documentation
Jacson consists of many plugabble components. To
fullfill the "configure not program" paradigm, a user
documentation of these
would be necessary.
The xslt documentation system allready includes some
hooks, so the idea would be to insert the user
documentation in the plugin class main JavaDoc section.
That would work immediately. Unfortunately there isn't
much helpful information in those sections yet and the
information is very different.
A style quide how the information should look should be
the Ant-Task documentation which has also been used by
the Jacson documentation on the Jacson Ant task.
To make the effort useful ASAP, the order of proceeding
should be per plugin type in that particular order:
1. Filters
2. Selections
3. Reports
4. Evaluators
5. Sources (not really plugins I know)
Logged In: YES
user_id=613247
I've created an generation of a plugin reference using xdoclet.
The used information is mainly received directly from the
class'es attributes. Additionally some new annotations jacon:
plugin and jacson:param were introduced.
Have a look at http:jacson.sf.net/reference/index.html