16f6c0aecf
Inline adoc files when they are included exactly once. Also fix language tags because this inlining gives us better information on what language the code is written in.
59 lines
1.7 KiB
Plaintext
59 lines
1.7 KiB
Plaintext
== Why is this an issue?
|
|
|
|
Each program should contain an initial section of ``++H*++`` comments lines, which includes a copyright and/or license statement. This rule must be fed with the header text that is expected in the header.
|
|
|
|
=== Compliant solution
|
|
|
|
[source,rpg]
|
|
----
|
|
H* Copyright (C) 2008-2013 SonarSource
|
|
H* mailto:contact AT sonarsource DOT com
|
|
H*
|
|
H* SonarQube is free software; you can redistribute it and/or
|
|
H* modify it under the terms of the GNU Lesser General Public
|
|
H* License as published by the Free Software Foundation; either
|
|
H* version 3 of the License, or (at your option) any later version.
|
|
H*
|
|
H* SonarQube is distributed in the hope that it will be useful,
|
|
H* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
H* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
H* Lesser General Public License for more details.
|
|
H*
|
|
H* You should have received a copy of the GNU Lesser General Public License
|
|
H* along with this program; if not, write to the Free Software Foundation,
|
|
H* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
=== Parameters
|
|
|
|
.headerFormat
|
|
****
|
|
|
|
Expected copyright and license header. Should not include positions 1 to 7.
|
|
****
|
|
.isRegularExpression
|
|
****
|
|
|
|
----
|
|
false
|
|
----
|
|
|
|
Whether the headerFormat is a regular expression
|
|
****
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
endif::env-github,rspecator-view[]
|