Generate Documentation wizard

Go Up to Project Management

You can use the Generate Documentation wizard to generate HTML documentation for your modeling projects. To open this dialog, activate the Model View or Diagram View and choose Tools > Generate Documentation from the main menu or Generate Documentation on the context menu.

The Generate Documentation wizard has the following controls:

Control	Description
Scope options	You can limit the scope of the documentation to a smaller set by choosing a different Scope option. The Scope section at the top of the dialog has radio buttons to indicate the parts of the project that should be parsed and included in the generated documentation: Current namespace -- Generated output includes only the current namespace selected in the Model View or Diagram View. Current namespace with descendant namespaces -- Generated output includes the current namespace selected in the Model View or Diagram View and any descendent namespaces under it. Current diagram -- Generated output for the current diagram that has the focus in the Diagram View. All -- Generated output covers the entire project.
Options settings	The Options section of the dialog has options to specify the destination and other optional actions: Output folder -- Enter the location for the generated output, or select from the file chooser. Include diagrams -- Check to include diagram images in the output. Include navigation tree -- Check to include a navigation tree in the output. Launch HTML browser -- Check to load the documentation into your external web browser. Note: The navigation frame in the documentation will work only if JDK/JRE 1.4 is installed and enabled in your browser.
OK	Accepts the input and starts the generate documentation process.
Cancel	Cancels your input and closes the dialog box without generating documentation.

See Also

• Documentation Generation
• Generating Project Documentation