rspec/rules/S2094/java/rule.adoc

== Why is this an issue?

include::../description.adoc[]

include::../noncompliant.adoc[]

=== Compliant solution

[source,java]
----
public interface Nothing {
}
----


=== Exceptions

Empty classes can be used as marker types (for Spring for instance), therefore empty classes that are annotated will be ignored.

[source,java]
----
@Configuration
@EnableWebMvc
public final class ApplicationConfiguration {

}
----

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[]
migrate rule descriptions to new education format 2023-05-03 11:06:20 +02:00			`== Why is this an issue?`

Add rules 2000-2999 2020-06-30 12:48:07 +02:00			`include::../description.adoc[]`

			`include::../noncompliant.adoc[]`

Clean rule at root In some cases, the `rule.adoc` at root of a rule is never included anywhere and thus is dead code. It's a maintenance cost by itself, but also it misses opportunities to inline code that seems used by two documents when in fact only one document is actually rendered. And this missed opportunity, in turn, stops us from applying the correct language tag on the code samples. 2023-10-16 16:34:38 +02:00			`=== Compliant solution`

			`[source,java]`
			`----`
			`public interface Nothing {`
			`}`
			`----`

Add rules 2000-2999 2020-06-30 12:48:07 +02:00
migrate rule descriptions to new education format 2023-05-03 11:06:20 +02:00			`=== Exceptions`
Add rules 2000-2999 2020-06-30 12:48:07 +02:00
			`Empty classes can be used as marker types (for Spring for instance), therefore empty classes that are annotated will be ignored.`
Fix code block ambiguity with old header style Ensure blank line before list and clean the one leading space 2020-06-30 14:49:38 +02:00
Clean rule at root In some cases, the `rule.adoc` at root of a rule is never included anywhere and thus is dead code. It's a maintenance cost by itself, but also it misses opportunities to inline code that seems used by two documents when in fact only one document is actually rendered. And this missed opportunity, in turn, stops us from applying the correct language tag on the code samples. 2023-10-16 16:34:38 +02:00			`[source,java]`
Add rules 2000-2999 2020-06-30 12:48:07 +02:00			`----`
			`@Configuration`
			`@EnableWebMvc`
			`public final class ApplicationConfiguration {`

			`}`
			`----`
Export comments and rspec-to-rspec links from jira 2021-06-02 20:44:38 +02:00
Fix the comment display: rule-id, timestamp, GH visibility, link direction 2021-06-03 09:05:38 +02:00			`ifdef::env-github,rspecator-view[]`
RULEAPI-666: Migrate the "List of parameters", "Highlighting" and "Message" fields from jira RSPEC (#346) 2021-09-20 15:38:42 +02:00
			`'''`
			`== Implementation Specification`
			`(visible only on this page)`

			`include::../message.adoc[]`

RULEAPI-576: add a horizontal rule between rule description and comments 2021-06-08 15:52:13 +02:00			`'''`
Export comments and rspec-to-rspec links from jira 2021-06-02 20:44:38 +02:00			`== Comments And Links`
			`(visible only on this page)`

			`include::../comments-and-links.adoc[]`
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
Fix the comment display: rule-id, timestamp, GH visibility, link direction 2021-06-03 09:05:38 +02:00			`endif::env-github,rspecator-view[]`