Show: Delphi C++
Display Preferences

QA Audits dialog box

From RAD Studio
Jump to: navigation, search

Go Up to GUI of Audits and Metrics


Project > QA Audits

To open the QA Audits dialog box for Delphi projects, choose the Project > QA Audits menu command or choose the QA Audits context menu command in the Diagram View or Model View.

The QA Audits dialog box has the following components:

  • Scope—In this list button, select the parts of the project that Audits will be run against.
  • Selection—This pane contains the tree of all available audits. Here you can select the audits to estimate.
  • Properties—In this pane, select the properties to use with the audit selected in the Selection pane.
  • Description—This pane shows the description of the audit selected in the Selection pane.

Scope

The Scope list button is on the top of the dialog box. It shows the parts of the project that Audits will be run against.

Use the drop-down arrow to set the Scope for either the current Selection item (file in the Code Editor, diagram element in the Diagram View or model element in the Model View) or for the entire Project (Model for implementation projects). When choosing Selection, Audits are processed only for the file, namespace, or class that you have selected before invoking the QA Audits dialog box. If you choose Project (Model), Audits are processed for the entire project.

Tip: If you have not selected any item in the code editor, Diagram View, or Model View, then Scope uses the entire project. If you want to run Audits on a specific file, class, namespace, or diagram, make sure you have selected it before you open the QA Audits dialog box.

Selection Pane

The Selection pane occupies the left side of the dialog box. It provides a list of available audits organized by categories.

Select the check boxes next to the audits that you want to run. Check or clear the check box for a category to select or deselect all audits in the category. When you click an audit in the Selection pane, its description is displayed in the Description pane of the dialog box.

Use the Selection pane toolbar to load and save sets of custom audits and to specify which audits to run on your projects.

The Selection pane toolbar has the following buttons:

Button Description

Load audit set Load audit set

Opens the Load Audit Set dialog box to browse for an ADT or XML file to load a custom set of audits stored in this file.

Save audit set Save audit set

Opens the Save Audit Set dialog box for specifying the file name and location to save the currently selected set of audits in an ADT or XML file.

Select all audits Select all audits

Selects all audits.

Unselect all audits Unselect all audits

Deselects all audits.

Set default audits Set default audit set

Resets the selected audits to the default set.

Find audit by ID Find audit by ID

Opens the Find Audit dialog box. In Audit ID, type a string to use as a pattern to filter for IDentifiers of audits. The dialog box will show only the audits whose IDentifiers start with the specified string. Select the desired audit and click Find. The selected audit becomes the currently selected in the Selection pane.

Context menu commands

Find audit by ID (CTRL+F)

The same as the Find audit by ID button.


Properties Pane

The Properties pane occupies the right side of the dialog box. It shows the set of properties available for the audit currently selected in the Selection pane. Here you can edit options of properties. Where necessary, properties are explained in the description for the particular audit.

Use the following toolbar buttons to display properties in the desired manner:

Button Description

Categorized Categorized

Displays properties in expandable groups.

Alphabetic Alphabetic

Displays properties in alphabetical order.

Property pages Property pages

Displays Property pages, if any.


The set of properties vary depending on the selected audit.

Note: The Severity property is always present. You can assign an Info, Warning, Error, or Fatal level of severity to each selected audit. The severity level defines how serious the violations are. The selected severity level is displayed in the results.

Description Pane

The Description pane occupies the bottom of the dialog box. When you click an audit in the Selection pane, its description is displayed in the Description pane. Descriptions include brief explanations of what the audit looks for, examples of violations, and advice on how to correct the code.

Command Buttons

The dialog provides the following command buttons:

Button Description

Start

Runs the selected set of Audits.

Cancel

Discards all changes and closes the dialog box.

Help

Opens this Help topic.


Warning: Audits are not available for design projects.
Note: You can apply Audits only to files registered in the current project.

See Also

Personal tools
RAD Studio 10.2 Tokyo
In other languages
Previous Versions
Assistance