Added comment to checkstyle suppression

Change-Id: I7c7c89e8b4367bbc2ea7a97e403eb253e955a9a5
Issue-ID: POLICY-1074
Signed-off-by: Jim Hahn <jrh3@att.com>

diff --git a/applications/monitoring/checkstyle-suppressions.xml b/applications/monitoring/checkstyle-suppressions.xml
index 4f662b8..b7d7df4 100644 (file)
--- a/applications/monitoring/checkstyle-suppressions.xml
+++ b/applications/monitoring/checkstyle-suppressions.xml
@@ -6,23 +6,29 @@
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at
-  
+
        http://www.apache.org/licenses/LICENSE-2.0
-  
+
   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
-  
+
   SPDX-License-Identifier: Apache-2.0
   ============LICENSE_END=========================================================
+
+
+  **** NOTE ****
+  This file is needed in case Cucumber-style tests are added, as they do not
+  conform to the checkstyle conventions.
+  **************
 -->
- 
+
 <!DOCTYPE suppressions PUBLIC
      "-//Puppy Crawl//DTD Suppressions 1.0//EN"
      "http://www.puppycrawl.com/dtds/suppressions_1_0.dtd">
- 
+
 <suppressions>
   <suppress checks="AbbreviationAsWordInName"
     files="Stepdefs.java"