C++ Audits Configuration dialog box

From RAD Studio
Jump to: navigation, search

Go Up to GUI of Audits and Metrics


C++ Audits pane > C++ Audits Configuration button

To open the C++ Audits Configuration dialog box for C++ projects, click the C++ Audits Configuration button C++ Audits Configuration button in the C++ Audits pane.

The C++ Audits Configuration dialog box has the following components:

  • Selection—This pane contains the tree of all available C++ 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 short description of the audit selected in the Selection pane. You can find extended descriptions of C++ audits in the C++ Audits topic.

Selection Pane

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

Select the check boxes next to the audits that you want to run. When you click an audit in the Selection pane, its properties are displayed in the Properties pane of the dialog box.

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.

Description Pane

The Description pane occupies the bottom of the dialog box. When you click an audit in the Selection pane, its short description is displayed in the Description pane. Descriptions include brief explanations of what the audit looks for. You can find extended descriptions of C++ audits in the C++ Audits topic. The extended descriptions can provide 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: C++ audits are not available for design projects.

See Also