Issue checkstyle#6586: aligned javadoc/xdoc for MissingSwitchDefault

Vantuz · Apr 3, 2019 · 15b6e5e · 15b6e5e
1 parent cc767f5
commit 15b6e5e
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 4 deletions.
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/MissingSwitchDefaultCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/MissingSwitchDefaultCheck.java
@@ -26,7 +26,7 @@
 
 /**
  * <p>
- * Checks that switch statement has &quot;default&quot; clause.
+ * Checks that switch statement has a &quot;default&quot; clause.
  * </p>
  * <p>
  * Rationale: It's usually a good idea to introduce a
@@ -38,11 +38,13 @@
  * introduction of new types in an enumeration type.
  * </p>
  * <p>
- * An example of how to configure the check is:
+ * To configure the check:
  * </p>
  * <pre>
- * &lt;module name="MissingSwitchDefault"/&gt;
+ * &lt;module name=&quot;MissingSwitchDefault&quot;/&gt;
  * </pre>
+ *
+ * @since 3.1
  */
 @StatelessCheck
 public class MissingSwitchDefaultCheck extends AbstractCheck {

diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/internal/XdocsJavaDocsTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/internal/XdocsJavaDocsTest.java
@@ -106,6 +106,7 @@ public class XdocsJavaDocsTest extends AbstractModuleTestSupport {
         "MissingCtor",
         "MissingDeprecated",
         "MissingOverride",
+        "MissingSwitchDefault",
         "NeedBraces",
         "PackageAnnotation",
         "PackageName",

diff --git a/src/xdocs/config_coding.xml b/src/xdocs/config_coding.xml
@@ -2642,8 +2642,8 @@ class TestMethodCall {
     </section>
 
     <section name="MissingSwitchDefault">
+      <p>Since Checkstyle 3.1</p>
       <subsection name="Description" id="MissingSwitchDefault_Description">
-        <p>Since Checkstyle 3.1</p>
         <p>
           Checks that switch statement has a &quot;default&quot; clause.
         </p>