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.
50 lines
883 B
Plaintext
50 lines
883 B
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,java]
|
|
----
|
|
public void doSomething() {
|
|
super.doSomething();
|
|
}
|
|
|
|
@Override
|
|
public boolean isLegal(Action action) {
|
|
return super.isLegal(action);
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,java]
|
|
----
|
|
@Override
|
|
public boolean isLegal(Action action) { // Compliant - not simply forwarding the call
|
|
return super.isLegal(new Action(/* ... */));
|
|
}
|
|
|
|
@Id
|
|
@Override
|
|
public int getId() { // Compliant - there is annotation different from @Override
|
|
return super.getId();
|
|
}
|
|
----
|
|
|
|
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[]
|