RAD Studio (Common)
ContentsIndex
PreviousUpNext
Generate Documentation dialog box

ToolsOptionsModelingGenerate Documentation 

Modeling features a UML documentation wizard that you can use to generate HTML documentation for your projects. To open this dialog, choose ToolsOptionsModelingGenerate Documentation. from the main menu. The Modeling dialog boxes have built-in help, in addition to this help.

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 what parts of the project should be parsed and included in the generated documentation:
Current namespace -- Generated output includes only the current namespace selected in the Model View or in the Diagram View.
Current namespace with descendent namespaces -- Generated output includes the current namespace selected in the Model View and any descendent namespaces under it.
Current diagram -- Generated output for the current diagram that is in 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.  
Copyright(C) 2009 Embarcadero Technologies, Inc. All Rights Reserved.
What do you think about this topic? Send feedback!