aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/sonar-checkstyle-plugin
diff options
context:
space:
mode:
authorSimon Brandhof <simon.brandhof@gmail.com>2011-07-26 11:56:30 +0200
committerSimon Brandhof <simon.brandhof@gmail.com>2011-07-26 11:56:30 +0200
commit19dd6430901914d364ecfea2ec8c83ee1fae321a (patch)
treec123953c75ae144238a1473edb0d6f73bb694d1c /plugins/sonar-checkstyle-plugin
parent2ef985b4603128e17ae4228d54b7d16ae58c007f (diff)
downloadsonarqube-19dd6430901914d364ecfea2ec8c83ee1fae321a.tar.gz
sonarqube-19dd6430901914d364ecfea2ec8c83ee1fae321a.zip
SONAR-2644 remove description and name from checkstyle rule HeaderCheck
Diffstat (limited to 'plugins/sonar-checkstyle-plugin')
-rw-r--r--plugins/sonar-checkstyle-plugin/src/main/resources/org/sonar/plugins/checkstyle/rules.xml31
1 files changed, 11 insertions, 20 deletions
diff --git a/plugins/sonar-checkstyle-plugin/src/main/resources/org/sonar/plugins/checkstyle/rules.xml b/plugins/sonar-checkstyle-plugin/src/main/resources/org/sonar/plugins/checkstyle/rules.xml
index 64a18f14d84..5f7494d662d 100644
--- a/plugins/sonar-checkstyle-plugin/src/main/resources/org/sonar/plugins/checkstyle/rules.xml
+++ b/plugins/sonar-checkstyle-plugin/src/main/resources/org/sonar/plugins/checkstyle/rules.xml
@@ -1,26 +1,17 @@
<rules>
<!-- Checkstyle 5.0 -->
- <rule key="com.puppycrawl.tools.checkstyle.checks.header.HeaderCheck" >
-<priority>MAJOR</priority>
- <name><![CDATA[Header]]></name>
- <configKey><![CDATA[Checker/Header]]></configKey>
-
- <description><![CDATA[<p>Checks that a source file begins with a specified header. Property headerFile specifies a file that contains the required header. Alternatively, the header specification can be set directly in the header property without the need for an external file.</p>
-<p>Property ignoreLines specifies the line numbers to ignore when matching lines in a header file. This property is very useful for supporting headers that contain copyright dates. For example, consider the following header:</p>
-<pre>
- line 1: ////////////////////////////////////////////////////////////////////
- line 2: // checkstyle:
- line 3: // Checks Java source code for adherence to a set of rules.
- line 4: // Copyright (C) 2002 Oliver Burn
- line 5: ////////////////////////////////////////////////////////////////////
-</pre>
-<p>Since the year information will change over time, you can tell Checkstyle to ignore line 4 by setting property ignoreLines to 4.</p>]]></description>
- <param key="header" type="s">
- <description><![CDATA[the required header specified inline. Individual header lines must be separated by the string "\n" (even on platforms with a different line separator)]]></description>
- </param>
- <param key="ignoreLines" type="s">
- <description><![CDATA[comma-separated list of line numbers to ignore]]></description>
+ <rule>
+ <key>com.puppycrawl.tools.checkstyle.checks.header.HeaderCheck</key>
+ <priority>MAJOR</priority>
+ <configKey>Checker/Header</configKey>
+ <param>
+ <key>header</key>
+ <type>s</type>
+ </param>
+ <param>
+ <key>ignoreLines</key>
+ <type>s</type>
</param>
</rule>