Issue checkstyle#6725: aligned javadoc/xdoc for FinalClass

pbludov · May 8, 2019 · db9f7f5 · db9f7f5
1 parent 9a2f293
commit db9f7f5
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/design/FinalClassCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/FinalClassCheck.java
@@ -31,16 +31,18 @@
 
 /**
  * <p>
- * Checks that class which has only private ctors
+ * Checks that a class which has only private constructors
  * is declared as final. Doesn't check for classes nested in interfaces
  * or annotations, as they are always {@code final} there.
  * </p>
  * <p>
- * An example of how to configure the check is:
+ * To configure the check:
  * </p>
  * <pre>
- * &lt;module name="FinalClass"/&gt;
+ * &lt;module name=&quot;FinalClass&quot;/&gt;
  * </pre>
+ *
+ * @since 3.1
  */
 @FileStatefulCheck
 public class FinalClassCheck

diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/internal/XdocsJavaDocsTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/internal/XdocsJavaDocsTest.java
@@ -92,6 +92,7 @@ public class XdocsJavaDocsTest extends AbstractModuleTestSupport {
         "EqualsHashCode",
         "ExplicitInitialization",
         "FallThrough",
+        "FinalClass",
         "FinalLocalVariable",
         "HiddenField",
         "IllegalCatch",

diff --git a/src/xdocs/config_design.xml b/src/xdocs/config_design.xml
@@ -259,8 +259,8 @@ public class FooTest {
     </section>
 
     <section name="FinalClass">
+      <p>Since Checkstyle 3.1</p>
       <subsection name="Description" id="FinalClass_Description">
-        <p>Since Checkstyle 3.1</p>
         <p>
           Checks that a class which has only private constructors is declared
           as final. Doesn't check for classes nested in interfaces