Modeling - Generate Documentation Options

From RAD Studio
Jump to: navigation, search

Go Up to Modeling Options

Tools > Options > Modeling > (level) > Generate Documentation

Here (level) is used to specify that the Generate Documentation options page can be selected in the Project, Project Group, and Default branches of the Modeling options tree. (See Hierarchical Levels of Modeling options in the Modeling Options dialog box topic for more information.)


The Generate Documentation options control the variety of content to include to or exclude from your generated HTML documentation describing diagrams and how included elements appear in the generated documentation.

Generate Documentation options

Option Description and default value

Bottom

Specifies the bottom text to be placed in each generated documentation file.
The text will be shown at the bottom, below the lower navigation bar.
The text can contain HTML tags and white spaces.

Documentation Title

Specifies the title to be placed at the top of the generated overview summary file.
The title will be shown as a centered, level-one heading directly beneath the upper navigation bar.
It can contain HTML tags and white spaces.

Footer text

Specifies the footer text to be placed in each generated documentation file.
The footer is shown to the right of the lower navigation bar.
It can contain HTML tags and white spaces.
The footer is generated when Generate navigation bar, header, footer is True.

Header text

Specifies the header text to be placed in each generated documentation file.
The header is shown to the right of the upper navigation bar.
It can contain HTML tags and white spaces.
The header is generated when 'Generate navigation bar, header, footer' is True.

Navigation type

Defines where to place descriptions of design elements:

  • Package—in package files
  • Diagram—in diagram files

The default is Package.

Use Internal Browser

True—use the internal browser for documentation presentation.
The default is False.

Window Title

Specifies the title text to be placed in the HTML <title> tag in each generated documentation file.
This text appears in the window title and in any browser bookmarks (favorites) created for this page.
This title should not contain any HTML tags, since browsers cannot interpret them properly.


Include options

Option Description and default value

internal (package)

True—internal classes (package in design projects), interfaces, and members are shown in the generated documentation.
The default is True.

private

Trueprivate classes, interfaces, and members are shown in the generated documentation.
The default is False.

protected

Trueprotected classes, interfaces, and members are shown in the generated documentation.
The default is False.

protected internal

Trueprotected internal classes, interfaces, and members are shown in the generated documentation.
The default is False.

public

Truepublic classes, interfaces, and members are shown in the generated documentation.
The default is False.


Navigation options

Option Description and default value

Generate Help

Controls whether to put the Help link in the navigation bars at the top and bottom of each page.
The default is True.

Generate Index

Controls whether to generate the Index in the navigation bars at the top and bottom of each page.
The default is True.

Generate navigation bar, header, footer

Controls whether to generate the navigation bar, header, and footer at the top and bottom of generated pages.
The default is True.

Generate tree

Controls whether to generate the class/interface hierarchy.
The default is True.

Generate Use

True—the 'Use' page is generated for each documented class and namespace. This page lists namespaces, classes, methods, constructors, and fields that use API elements of the given class or package.
Given the C class, things that use it would include subclasses of C, fields declared as C, methods that return C, and methods and constructors with parameters of type C.
The default is False.


See Also