51369b610e
When an include is not surrounded by empty lines, its content is inlined on the same line as the adjacent content. That can lead to broken tags and other display issues. This PR fixes all such includes and introduces a validation step that forbids introducing the same problem again.
31 lines
779 B
Plaintext
31 lines
779 B
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Exceptions
|
|
|
|
This rule does not apply to code documentation using Doxygen, QDoc, markdown, or HTML tags.
|
|
|
|
== Resources
|
|
|
|
* MISRA C:2004, 2.4 - Sections of code should not be "commented out".
|
|
* MISRA {cpp}:2008, 2-7-2 - Sections of code shall not be "commented out" using C-style comments.
|
|
* MISRA {cpp}:2008, 2-7-3 - Sections of code should not be "commented out" using {cpp} comments.
|
|
* MISRA C:2012, Dir. 4.4 - Sections of code should not be "commented out"
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|