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.
43 lines
1.2 KiB
Plaintext
43 lines
1.2 KiB
Plaintext
== Why is this an issue?
|
|
|
|
Each source file should start with a header stating file ownership and the license which must be used to distribute the application.
|
|
|
|
This rule must be fed with the header text that is expected at the beginning of every file.
|
|
|
|
|
|
The ``++headerFormat++`` must end with an empty line if you want to have an empty line between the file header and the first line for your source file (``++using++``, ``++namespace++``...).
|
|
|
|
|
|
For example, if you want the source file to look like this
|
|
|
|
----
|
|
// Copyright (c) SonarSource. All Rights Reserved. Licensed under the LGPL License. See License.txt in the project root for license information.
|
|
|
|
namespace Foo
|
|
{
|
|
}
|
|
----
|
|
then the ``++headerFormat++`` parameter should end with an empty line like this
|
|
|
|
----
|
|
// Copyright (c) SonarSource. All Rights Reserved. Licensed under the LGPL License. See License.txt in the project root for license information.
|
|
----
|
|
|
|
include::../compliant.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[]
|