From 4fdcae8d12f728d2ceff41aa34d4b9317424adfb Mon Sep 17 00:00:00 2001
From: Paul Campbell <pcampbell@kemitix.net>
Date: Wed, 8 Feb 2017 09:48:06 +0000
Subject: [PATCH] plugin-sample:Sample: add note clarifying ruleset level
 compliance

The class is meant to fail at higher levels.
---
 .../src/main/java/net/kemitix/checkstyle/sample/Sample.java    | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/plugin-sample/src/main/java/net/kemitix/checkstyle/sample/Sample.java b/plugin-sample/src/main/java/net/kemitix/checkstyle/sample/Sample.java
index 9f7eaba..55b178e 100644
--- a/plugin-sample/src/main/java/net/kemitix/checkstyle/sample/Sample.java
+++ b/plugin-sample/src/main/java/net/kemitix/checkstyle/sample/Sample.java
@@ -27,6 +27,9 @@ package net.kemitix.checkstyle.sample;
 /**
  * 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)
  */
 public class Sample {