Overview of this quick tour

The essential notions

In order to generate documentation, you must have a structured model, in which a package, called the documentation package, references all the elements that should appear in the documentation.

This package is used to group together classes, other packages or themes, as well as use cases. The order in which packages and other elements are presented will be used to organize the documentation into chapters.

For each element, different types of notes, which describe various aspects of the element, are proposed. Once your model has been annotated using these notes, documentation generation can then be run.

In the Objecteering MDAC configuration window, you can parameterize your favorite editors, as well as the generation directory.

Before starting

Before beginning this quick tour, you must first deploy the Documentation MDA component in your project, by running the "Tools/Deploy an MDAC" command and selecting the Documentation MDAC.

For more details on deploying MDA components, please see "Working with MDACs".