Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions scripts/generate_rules/templates/misra-c++-2023-help.md.template
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# {{ rule_id }}: {{ name }}

This query implements the {{ standard_name | escape }} rule {{ rule_id | escape }}:

> {{ rule_title }}

## Classification

** REPLACE THIS WITH THE CORRECT CLASSIFICATION **
* required
* implementation
* automated

## Rationale

**REPLACE THIS WITH RATIONAL, IF ANY**

## Exception

**REPLACE THIS WITH EXCEPTION, IF ANY**

## Example

```cpp
// REPLACE THIS WITH C++ EXAMPLE, IF ANY
```

## See more

** REPLACE THIS WITH THE ANY SEE MORE REFERENCES **

## Implementation notes

{% if implementation_scope is defined %}
{{ implementation_scope["description"] }}
{% if implementation_scope["items"] is iterable %}
{% for implementation_scope_entry in implementation_scope["items"] %}
* {{ implementation_scope_entry }}
{% endfor %}
{% endif %}
{% else %}
None
{% endif %}

## References

{% if standard_title | length %}
* {{ standard_title | escape }}: [{{ rule_id }}: {{ rule_title }}]({{ standard_url }})
{% endif %}
Loading