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.
56 lines
782 B
Plaintext
56 lines
782 B
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,java]
|
|
----
|
|
private void called(int foo) {
|
|
foo==1; // Noncompliant
|
|
if (foo==1) {
|
|
System.out.println("foo\n");
|
|
}
|
|
}
|
|
|
|
public void caller(String [ ] args {
|
|
called(2);
|
|
return 0;
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,java]
|
|
----
|
|
private void called(int foo) {
|
|
foo=1;
|
|
if (foo==1) {
|
|
System.out.println("foo\n");
|
|
}
|
|
}
|
|
|
|
public void caller(String [ ] args {
|
|
called(2);
|
|
return 0;
|
|
}
|
|
----
|
|
|
|
include::../see.adoc[]
|
|
|
|
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[]
|