RAD Studio (Common)
ContentsIndex
PreviousUpNext
Together Generate Documentation Options

ToolsOptionsTogetherVariousGenerate Documentation 

Descriptions for generate documentation options. 

The Generate Documentation options control the variety of content (as well as appearance) to include or exclude from your generated HTML documentation. The table below lists the Generate Documentation options, descriptions, and default values.

General group Options 
Description and default value 
Bottom 
Specifies the text to be placed at the bottom of each output file. The text will be placed at the bottom of the page, 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 overview summary file. The title will be placed as a centered, level-one heading directly beneath the upper navigation bar. It can contain HTML tags and white spaces.  
Footer 
Specifies the footer text to be placed at the bottom of each output file. The footer is placed to the right of the lower navigation bar. It can contain HTML tags and white spaces.  
Header 
Specifies the header text to be placed at the top of each output file. The header is placed to the right of the upper navigation bar. It can contain HTML tags and white spaces.  
Navigation type 
Specifies the location for descriptions of design elements:
Package: in package files
Diagram: in diagram files
The default value is Package.  
Use Internal Browser 
When this options is true, an internal browser is used for documentation presentation.
The default value is False.  
Window Title 
Specifies the title to be placed in the HTML <title> tag. 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 the browser does not interpret them properly.  

 

Include group Options 
Description and default value 
internal (package) 
If this option is true, internal classes (friend in VB), interfaces and members are shown in the generated documentation.
The default value is True.  
private 
If this option is true, private classes, interfaces and members are shown in the generated documentation.
The default value is False.  
protected 
If this option is true, protected classes, interfaces and members are shown in the generated documentation.
The default value is False.  
protected internal 
If this option is true, protected internal classes (protected friend in VB), interfaces and members are shown in the generated documentation.
The default value is False.  
public 
If this option is true, public classes, interfaces and members are shown in the generated documentation.
The default value is True.  

 

Navigation group Options 
Description and default value 
Generate Help 
This option controls whether to put the HELP link in the navigation bars at the top and bottom of each page of output.
The default value is True.  
Generate Index 
This option controls whether to generate the index.
The default value is True.  
Generate Navbar 
This option controls whether to generate the navigation bar, header, and footer, otherwise found at the top and bottom of the generated pages.
The default value is True.  
Generate Tree 
This option controls whether to generate the class/interface hierarchy.
The default value is True.  
Generate Use 
If this option is true, one Use page is included for each documented class and namespace. The page describes which namespaces, classes, methods, constructors, and fields use any API of the given class or namespace. Given class C, things that use class C would include subclasses of C, fields declared as C, methods that return C, and methods and constructors with parameters of type C.
The default value is False.  
Copyright(C) 2008 CodeGear(TM). All Rights Reserved.
What do you think about this topic? Send feedback!