rspec/rules/S1309/java/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

43 lines
774 B
Plaintext

== Why is this an issue?
This rule allows you to track the usage of the ``++@SuppressWarnings++`` mechanism.
=== Noncompliant code example
With a parameter value of "unused" :
[source,java]
----
@SuppressWarnings("unused")
@SuppressWarnings("unchecked") // Noncompliant
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Suppressing the 'xxxxxx' warning is not allowed.
=== Parameters
.listOfWarnings
****
Comma separated list of warnings that can be suppressed. Example: 'unchecked, cast, all, boxing'. An empty list means that no warning can be suppressed.
****
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]