rspec/rules/S2234/cfamily/rule.adoc
Fred Tingaud 51369b610e
Make sure that includes are always surrounded by empty lines (#2270)
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.
2023-06-22 10:38:01 +02:00

56 lines
885 B
Plaintext

== Why is this an issue?
include::../description.adoc[]
=== Noncompliant code example
[source,cpp]
----
int divide(int divisor, int dividend) {
return divisor / dividend;
}
void doTheThing() {
int divisor = 15;
int dividend = 5;
int result = divide(dividend, divisor); // Noncompliant; operation succeeds, but result is unexpected
//...
}
----
=== Compliant solution
[source,cpp]
----
int divide(int divisor, int dividend) {
return divisor / dividend;
}
void doTheThing() {
int divisor = 15;
int dividend = 5;
int result = divide(divisor, dividend);
//...
}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
include::../highlighting.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]