Documentation Generator Options

Project Documentation Generator Options

The Documentation Generator Options dialog have three tabs

General

Directories

RTF

Graphics

Tables

DXY

General

Build database before generating

If this option is selected, the database is updated before documentation generation. In order for the generated documents to be up-to-date, we suggest that you should select this option. However, updating the database leads to closing all open Graphs and Browsers, and also, if the project contains a fatal error, updating the database will cancel documentation generation. Therefore, if you work on documentation templates developing, it is advisable to disable the Update database before generating option. In that case, the appropriate Warning will be reported during documentation generation to remind you to select the Update database before generating option when you start documentation generation on the basis of developed templates.

Add New Documentation Template to Project

When this option is enabled, each new created Documentation Template will be added to the current project.

Directories

This tab specifies the directories important for Documentation Generator functioning. All paths to folders can be relative to the Project Root or absolute.

Generated Documents Directory

It specifies the directory in which the generated documents will be stored. If one has not been specified, the default directory is the Project Root directory.

Documentation Templates Directory

It specifies the directory to be opened as default in the New Template, Open Template, Generate (tab Existing) and Check Template(s) (tab Existing) dialog box. If one has not been specified, the default directory is the Project Root directory.

Standard Documentation Templates Directory

It specifies the directory in which standard DTs reside. If one has not been specified, the default directory is the Project Root directory.

RTF

In this tab, you can set options for generating documentation.

Add generated documents to project

If this option is enabled, all documents generated will be included in the project (in the logical group Default(types)/Document Files/Generated Documents). Miscellaneous Files or in Default(types)/Document Files if the extension ".rtf" has been entered in the Document File box, in the File Types tab of the Project Options dialog box).

Open generated documents after generating

If this option is enabled once documentation generation has been completed, the generated document will be opened in DTE.

Save Documentation Template before generating

If this option is enabled the documentation template will be always saved..

Skip standard documentation templates checking

If this option is enabled the correctness of all standard DTs included in the starting DT is not checked.

Check all included templates

If this option is enabled the correctness of all DTs included in the starting DT is checked (when the include directive is encountered).

Comment Wizard Source Code

When this option is enabled during script integration into Documentation Template (DT), the Wizard adds a corresponding comment to each script in the block.

Generate

The way in which documentation is to be generated is specified in this group of options.

Active Documentation Template

If this option is enabled, generation is carried out on the basis of the DT currently active in DTE.

Selected Documentation Template

If this option is enabled, then, when each generation is started, a dialog box is brought up in which one or more templates can be chosen on the basis of which generation will be performed.

Documentation Template

If this option is enabled, the documentation template on the basis of which generation will be carried out can be assigned.

Graphics

This tab specifies the graphic formats and needed converter.

JPG, PNG and GIF

For those formats you must use one third party tool. We have good experiences with Microsort Paint.

WMF

DA-C originally saves graphics in WMF format, so you don't need to use third party converter tools.

Microsoft Paint

Microsoft Paint "understands" Microsoft WMF Format and conversions to other Graphics Formats. We may recommend using this converter. The disadvantage is that you will see many dialogs that open and automatically close... The keyboard "File > Save As..." sequence is Windows language-dependent.

%f = Alt+f = Microsoft Paint menu "File"
%a = Alt+a = "Save as..." command

%n = Alt+n = "File name" field
$F = Insert file name

%t = Alt+t = "Save as type" dropdown list
%E = Converted file type
%s = Alt+ s = "Save"

@E = "Enter" to close this dialog

Only for GIF format @E generates two "Enter"

Converter Command Line

Here you may define the Command Line for WMF to JPG, PNG or GIF format conversion. Macro %WmfFile stands for WMF, %JpgFile for JPG, %PngFile for PNG and %GifFile for GIF file name.

Tables

This tab specifies the format for saving of Source Code Metrics. Table Views and Messages Logs.

CSV, RTF and TXT

Those formats are directly supported and you don't need any converter.

DXY

This tab defines the Doxygen specific options.

DA-C Doxygen Script file

Here you may define scripts file for Doxygen documentation parts generation.