Generating Documentation for a Folder or Database/Workspace Item

  1. Set the options for documentation generation.
  2. Select the items you want to document.
  3. In the Documentation Contents window, open the Document menu and select Generate Document.

    A naming window opens.

  4. Enter a file name and click OK.

    If you selected at least one C code component for documentation, the "Targets" window opens. It lists all targets installed on your computer.

  5. Select the target(s) for which you wand to generate documentation, then click OK.

    The documentation is generated for all items (and – for C code components – all selected targets) shown in the Documentation Contents window, in the selected format.

  6. If desired, view or print the generated documentation.

The generated files are stored in the documentation directory of your ASCET installation. This directory is specified in the ASCET Options window, Environment node, Paths subnode. Every time you generate documentation, any older files with identical names are overwritten.

See also

Setting the Options for Documentation Generation

Selecting the Items for Generating Documentation

Component Manager – Paths Options (Environment)