Generate traceability report
Report with hyperlinks to code to model and model to code
Model Configuration Pane: Report
Description
Enable or disable generation of an HTML code generation report with hyperlinks from code to model and model to code. The report provides line-level traceability for each block in your Simulink® model. When you click the hyperlink beside a certain line of code in the report, HDL Coder™ highlights the corresponding block in your Simulink model. When you select a certain block in your model, the report highlights all lines of code corresponding to that block.
Dependencies
When you select this check box, you can select the Traceability style. By default, the Traceability style is Line Level
.
Settings
Off
(Default) | On
On
Create and display a traceability report section in the HTML code generation report. To generate the report, after you enable this setting, click the Generate button. The code generation report contains a summary section and a code interface report along with the traceability report.
Off
Do not create an HTML code generation report.
Tips
To set this property, use the functions hdlset_param
or makehdl
. To view the property value, use
the function hdlget_param
.
For example, you can generate a traceability report when
generating HDL code for the symmetric_fir
subsystem inside the sfir_fixed
model using
either of these methods.
Pass in the
Traceability
parameter as an argument tomakehdl
.makehdl('sfir_fixed/symmetric_fir','Traceability','on')
Enable the Traceability parameter using
hdlset_param
and then usemakehdl
.hdlset_param('sfir_fixed','Traceability','on') makehdl('sfir_fixed/symmetric_fir')
You can use the RequirementComments
parameter
to generate hyperlinked requirements comments within the HTML code
generation report. The requirements comments link to the
corresponding requirements documents for your model.
Recommended Settings
No recommendations.
Programmatic Use
Parameter:
Traceability |
Type: Character vector |
Value: 'on' | 'off' |
Default: 'off' |
Version History
Introduced in R2012a