Issue checkstyle#13345: Enabled AtClauseOrderCheckExamplesTest

src/xdocs-examples/java/com/puppycrawl/tools/checkstyle/checks/javadoc/AtclauseOrderCheckExamplesTest.java

@@ -19,12 +19,12 @@
 
 package com.puppycrawl.tools.checkstyle.checks.javadoc;
 
-import org.junit.jupiter.api.Disabled;
+import static com.puppycrawl.tools.checkstyle.checks.javadoc.AtclauseOrderCheck.MSG_KEY;
+
 import org.junit.jupiter.api.Test;
 
 import com.puppycrawl.tools.checkstyle.AbstractExamplesModuleTestSupport;
 
-@Disabled("until https://github.com/checkstyle/checkstyle/issues/13345")
 public class AtclauseOrderCheckExamplesTest extends AbstractExamplesModuleTestSupport {
     @Override
     protected String getPackageLocation() {
@@ -33,10 +33,45 @@ protected String getPackageLocation() {
 
     @Test
     public void testExample1() throws Exception {
+        final String tagOrder = "[@author, @version, @param, @return, @throws"
+            + ", @exception, @see,"
+            + " @since, @serial, @serialField, @serialData, @deprecated]";
+
         final String[] expected = {
+            "42: " + getCheckMessage(MSG_KEY, tagOrder),
+            "44: " + getCheckMessage(MSG_KEY, tagOrder),
+            "52: " + getCheckMessage(MSG_KEY, tagOrder),
+            "54: " + getCheckMessage(MSG_KEY, tagOrder),
+            "55: " + getCheckMessage(MSG_KEY, tagOrder),
+        };
+
+        verifyWithInlineConfigParser(getPath("Example1.java"), expected);
+    }
+
+    @Test
+    public void testExample2() throws Exception {
+        final String tagOrder = "[@author, @since, @version, @param, @return"
+            + ", @throws, @exception,"
+            + " @deprecated, @see, @serial, @serialField, @serialData]";
 
+        final String[] expected = {
+            "29: " + getCheckMessage(MSG_KEY, tagOrder),
+            "55: " + getCheckMessage(MSG_KEY, tagOrder),
+        };
+
+        verifyWithInlineConfigParser(getPath("Example2.java"), expected);
+    }
+
+    @Test
+    public void testExample3() throws Exception {
+        final String tagOrder = "[@author, @since, @version, @param, @return"
+            + ", @throws, @exception,"
+            + " @deprecated, @see, @serial, @serialField, @serialData]";
+
+        final String[] expected = {
+            "55: " + getCheckMessage(MSG_KEY, tagOrder),
         };
 
-        verifyWithInlineConfigParser(getPath("Example1.txt"), expected);
+        verifyWithInlineConfigParser(getPath("Example3.java"), expected);
     }
 }

src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/atclauseorder/Example1.java

@@ -0,0 +1,58 @@
+/*xml
+<module name="Checker">
+  <module name="TreeWalker">
+    <module name="AtclauseOrder"/>
+  </module>
+</module>
+*/
+
+
+
+
+
+
+package com.puppycrawl.tools.checkstyle.checks.javadoc.atclauseorder;
+
+import java.io.Serializable;
+
+// xdoc section -- start
+/**
+* Some javadoc.
+*
+* @author Some javadoc.
+* @version Some javadoc.
+* @param Some javadoc.
+* @return Some javadoc.
+* @throws Some javadoc.
+* @exception Some javadoc.
+* @see Some javadoc.
+* @since Some javadoc.
+* @serial Some javadoc.
+* @serialField
+* @serialData
+*/
+public class Example1 {}
+
+class Valid1 implements Serializable {}
+
+/**
+ * Some javadoc.
+ *
+ * @since Some javadoc.
+ * @version Some javadoc. // violation
+ * @deprecated
+ * @see Some javadoc. // violation
+ */
+class Invalid1 implements Serializable {}
+
+/**
+ * Some javadoc.
+ *
+ * @since Some javadoc.
+ * @version Some javadoc. // violation
+ * @deprecated
+ * @see Some javadoc. // violation
+ * @author max // violation
+ */
+enum Test1 {}
+// xdoc section -- end

src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/atclauseorder/Example2.java

@@ -0,0 +1,58 @@
+/*xml
+<module name="Checker">
+  <module name="TreeWalker">
+    <module name="AtclauseOrder">
+      <property name="tagOrder"
+                value="@author, @since, @version, @param, @return,
+                       @throws, @exception, @deprecated,
+                       @see, @serial, @serialField, @serialData"/>
+    </module>
+  </module>
+</module>
+*/
+
+package com.puppycrawl.tools.checkstyle.checks.javadoc.atclauseorder;
+
+import java.io.Serializable;
+
+// xdoc section -- start
+/**
+* Some javadoc.
+*
+* @author Some javadoc.
+* @version Some javadoc.
+* @param Some javadoc.
+* @return Some javadoc.
+* @throws Some javadoc.
+* @exception Some javadoc.
+* @see Some javadoc.
+* @since Some javadoc. // violation
+* @serial Some javadoc.
+* @serialField
+* @serialData
+*/
+public class Example2 {}
+
+class Valid2 implements Serializable {}
+
+/**
+ * Some javadoc.
+ *
+ * @since Some javadoc.
+ * @version Some javadoc.
+ * @deprecated
+ * @see Some javadoc.
+ */
+class Invalid2 implements Serializable {}
+
+/**
+ * Some javadoc.
+ *
+ * @since Some javadoc.
+ * @version Some javadoc.
+ * @deprecated Some javadoc.
+ * @see Some javadoc.
+ * @author max // violation
+ */
+enum Test2 {}
+// xdoc section -- end

src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/atclauseorder/Example3.java

@@ -0,0 +1,58 @@
+/*xml
+<module name="Checker">
+  <module name="TreeWalker">
+    <module name="AtclauseOrder">
+      <property name="target" value="ENUM_DEF"/>
+      <property name="tagOrder"
+                value="@author, @since, @version, @param, @return,
+                       @throws, @exception, @deprecated,
+                       @see, @serial, @serialField, @serialData"/>
+    </module>
+  </module>
+</module>
+*/
+package com.puppycrawl.tools.checkstyle.checks.javadoc.atclauseorder;
+
+import java.io.Serializable;
+
+// xdoc section -- start
+/**
+* Some javadoc.
+*
+* @author Some javadoc.
+* @version Some javadoc.
+* @param Some javadoc.
+* @return Some javadoc.
+* @throws Some javadoc.
+* @exception Some javadoc.
+* @see Some javadoc.
+* @since Some javadoc.
+* @serial Some javadoc.
+* @serialField
+* @serialData
+*/
+public class Example3 {}
+
+class Valid3 implements Serializable {}
+
+/**
+ * Some javadoc.
+ *
+ * @since Some javadoc.
+ * @version Some javadoc.
+ * @deprecated
+ * @see Some javadoc.
+ */
+class Invalid3 implements Serializable {}
+
+/**
+ * Some javadoc.
+ *
+ * @since Some javadoc.
+ * @version Some javadoc.
+ * @deprecated
+ * @see Some javadoc.
+ * @author Some javadoc. // violation
+ */
+enum Test3 {}
+// xdoc section -- end