Issue #464: Add note regarding conflict with other checks

sevntu-checkstyle · Aug 1, 2018 · 5917f4f · 5917f4f
1 parent 674967e
commit 5917f4f
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/...n/java/com/github/sevntu/checkstyle/checks/coding/EnumTrailingCommaAndSemicolonCheck.java b/...n/java/com/github/sevntu/checkstyle/checks/coding/EnumTrailingCommaAndSemicolonCheck.java
@@ -82,6 +82,11 @@
  * &lt;module name="EnumTrailingComma"/&gt;
  * </pre>
  *
+ * <p>Please note that using this check together with {@code NoWhitespaceBefore} or {@code SeparatorWrap} may create
+ * conflicts with enums that contain a body: {@code EnumTrailingComma} enforces the semicolon on a separate line while
+ * {@code NoWhiteSpaceBefore} does not allow the semicolon to be preceded with whitespace and {@code SeparatorWrap}
+ * expects the semicolon to be on the same line as the last enum constant.
+ *
  * @author <a href="[email protected]">Kariem Hussein</a>
  */
 public class EnumTrailingCommaAndSemicolonCheck extends AbstractCheck {