Home > Documentation
Templates
The documentation generation templates are containing three kinds
of information :
These templates can be edited either from the preferences or from the
documentation generation wizard.
Information
A template have a name and a description to explain what is it
dedicated for.
Content
When editing a template, it is possible to define what should be
included in the generated documentation.
- Packages
- Class and Interfaces
- Methods
- Attributes
- Diagrams
Class diagram dedicated to a class can be automatically generated.
Format
The final format of the generated documentation depends on a XSL
transformation. The XSLT template to use must be indicated.
For now, the DTD used for the XSL transformation is not published. It
will be enhanced and published on a further coming version.
Two default XSLT templates are provided :
- Javadoc-like documentation
- Eclipse Javadoc-like documentation (with Eclipse icons and
decoration added to a standard-style javadoc)
