# QAR Suppression Report Details

## Overview

The Suppression Report shows how comment-based suppression have been used in the project.

A summary of suppression usage and effect is displayed on the title page. The number of source and header files analysed is shown, along with the total lines of code from the files. Next the number of instances of messages suppressed is shown. Complementing this is a count of number of different messages suppressed. Finally the Percentage of messages suppressed is shown.

The main body of the report is divided in to sections, described below. If there are no relevant suppressions for a section it will be omitted.

### Redundant Suppressions

Firstly redundant suppressions are shown. A suppression can be redundant in one of two ways - either it duplicates an existing suppression or it does not suppress any messages - it is unused. If a suppression suppresses a message that has been turned off in the Message Personality, then it is counted as unused.

### Suppression by File

This section shows all the location based suppressions per file. These are suppressions which act on a single line, a number of lines or a range of lines defined by a location tag.

### Continuous Suppressions by File

Continuous suppressions are shown in this section. Continuous suppressions descend into header files, so header files may appear in this section without actually having any suppression comments in them.

### Suppression by Message/Group

This section shows the details of what messages or groups are suppressed. This section can be configured to show Suppression By Message, Suppression By Groups or both. This section can also be omitted using the `details=none` option setting. If using a compliance module, then the Suppression By Group is usually better as this will effectively display the suppressions by coding standard rules.

By default Suppression By Group will be used if a compliance module is being used (as specfied by a User Message File), otherwise Suppression by Message is the default.

## Report Specific Options

### Option Settings

`-po Suppression\ Report::details=<value>` - Specifies explicitly what to include in the details section of the report as follows:

`-po Suppression\ Report::details=message` - Show the suppression by message number.

`-po Suppression\ Report::details=group` - Show the suppression by group name.

`-po Suppression\ Report::details=both` - Show the suppression by message number and group name.

`-po Suppression\ Report::details=none` - Omit the details section from the report.

If this setting is omitted, Suppression By Group will be shown if a user message file is specified, otherwise to Suppression By Message will be shown.

### Boolean Settings

`-po Suppression\ Report::top_ten` - Show just the top 10 worst files or groups, rather than the top nine and then the rest.