Main Content

Check Model Description

Check ID: mathworks.jmaab.jc_0603

Guideline: jc_0603: Model description


Identifies the layers in a model that have inconsistent description formatting for the following model elements:

  • Annotations

  • Model Info block

  • DocBlock block

This check requires a Simulink® Check™ license.

Check Parameterization

This check contains sub-checks that correspond to sub IDs specified in the MAB and JMAAB modeling guidelines. You can use the Model Advisor Configuration Editor to specify which sub IDs (one or multiple) to execute.

For reference, the MAB guideline sub ID(s) that are recommended for use by the NA-MAAB and JMAAB modeling standards organizations are:

  • NA-MAAB — No recommendations

  • JMAAB — a, b

You can select the description block type and configure the description tags from the Description Block Type and Description Tags input parameters. The format for the Description Tags should be of a string type with comma separated tags.

By default, the Description Block Type is set to Annotation and the Description Tags parameter is Input:,Description:,Output:.

For example, considering the default values (Input:, Description:, Output:), each of the layer in the model should have the description format as following:

Input: <input information>

Description: <model description>

Output: <output information>

Results and Recommended Actions

Guideline Sub IDConditionRecommended Action
jc_0603_a: Check for layer description at each layerOne or more layers in the model do not have model descriptions.Add model descriptions at all layers in the model.
jc_0603_b: Check for consistent layer descriptionOne or more layers in the model do not have consistent model description formatting.Maintain a consistent format for model descriptions at all layers in the model.

Capabilities and Limitations

  • Runs on library models.

  • Analyzes content of library-linked blocks. By default, the input parameter Follow links is set to on.

  • Analyzes content in masked subsystems. By default, the input parameter Look under masks is set to graphical.

  • Supports exclusions of blocks or charts.