kemitix/kemitix-checkstyle-ruleset
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

plugin-sample:Sample: add note clarifying ruleset level compliance

Browse source 
The class is meant to fail at higher levels.
This commit is contained in:
Paul Campbell 2017-02-08 09:48:06 +00:00
parent 8306b096a6
commit 4fdcae8d12
1 changed files with 3 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
plugin-sample/src/main/java/net/kemitix/checkstyle/sample/Sample.java
View file

@ -27,6 +27,9 @@ package net.kemitix.checkstyle.sample;
/** /**
* Sample class to test the Kemitix Checkstyle Ruleset Maven Plugin against. * Sample class to test the Kemitix Checkstyle Ruleset Maven Plugin against.
* *
* <p>This sample is deliberately only valid for level 1-layout and 2-naming. The plugin should report errors for levels
* 3-javadoc and above.</p>
*
* @author Paul Campbell (paul.campbell@hubio.com) * @author Paul Campbell (paul.campbell@hubio.com)
*/ */
public class Sample { public class Sample {