Issue checkstyle#6966: aligned javadoc/xdoc for OuterTypeFilename

pbludov · Aug 12, 2019 · befc508 · befc508
1 parent 2f8bcac
commit befc508
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/OuterTypeFilenameCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/OuterTypeFilenameCheck.java
@@ -28,7 +28,18 @@
 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
 
 /**
+ * <p>
  * Checks that the outer type name and the file name match.
+ * For example, the class {@code Foo} must be in a file named {@code Foo.java}.
+ * </p>
+ * <p>
+ * To configure the check:
+ * </p>
+ * <pre>
+ * &lt;module name=&quot;OuterTypeFilename&quot;/&gt;
+ * </pre>
+ *
+ * @since 5.3
  */
 @FileStatefulCheck
 public class OuterTypeFilenameCheck 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
@@ -105,7 +105,6 @@ public class XdocsJavaDocsTest extends AbstractModuleTestSupport {
         "FinalParameters",
         "Indentation",
         "NewlineAtEndOfFile",
-        "OuterTypeFilename",
         "TodoComment",
         "TrailingComment",
         "Translation",

diff --git a/src/xdocs/config_misc.xml b/src/xdocs/config_misc.xml
@@ -1439,8 +1439,8 @@ key.png =value - violation
     </section>
 
     <section name="OuterTypeFilename">
+      <p>Since Checkstyle 5.3</p>
       <subsection name="Description" id="OuterTypeFilename_Description">
-        <p>Since Checkstyle 5.3</p>
         <p>
           Checks that the outer type name and the file name match. For example,
           the class <code>Foo</code> must be in a file named