QAR Code Review Report Details


Overview

The Code Review Report summarises metrics and messages from files, functions and classes. It can also display some code visualisations: includes, calls, relations and function structure. It gives a broad overview of the code and can be used, for example, in code review meetings.

Report Specific Options

Metric settings

Specify with -po Code\ Review\ Report::<metric_type>=['metric_1','metric_2',...]

e.g. To include the function metrics STCYC and STPTH use:

-po Code\ Review\ Report::function_metric=['STCYC','STPTH']

To omit a metrics section use empty brackets:

-po Code\ Review\ Report::class_metric=[]

note: maximum of ten of each metric allowed

-po Code\ Review\ Report::class_metric=... specifies class metrics.

-po Code\ Review\ Report::function_metric=... specifies function metrics.

-po Code\ Review\ Report::file_metric=... specifies file metrics.

-po Code\ Review\ Report::project_metric=... specifies project metrics.

Boolean Settings

Specify with -po Code\ Review\ Report::<setting> to turn on.

-po Code\ Review\ Report::no_structure Omits function structure diagrams

-po Code\ Review\ Report::no_includes Omits include files diagrams

-po Code\ Review\ Report::no_baseof Omits class is base of diagrams

-po Code\ Review\ Report::no_byref Omits class has by reference diagrams

-po Code\ Review\ Report::no_byval Omits class has by value diagrams

-po Code\ Review\ Report::no_byptr Omits class has by pointer diagrams

-po Code\ Review\ Report::no_calls Omits function calls diagrams