From abf829f542023e089c741c55f73098cae52dcb12 Mon Sep 17 00:00:00 2001 From: wltan <53135010+wltan@users.noreply.github.com> Date: Tue, 3 Mar 2020 00:00:08 +0800 Subject: [PATCH] Issue #7614: Update doc for OneTopLevelClass --- .../checks/design/OneTopLevelClassCheck.java | 22 +++++----- src/xdocs/config_design.xml | 40 +++++++++++-------- 2 files changed, 34 insertions(+), 28 deletions(-) diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/OneTopLevelClassCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/OneTopLevelClassCheck.java index a2493391186..439205dbda7 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/OneTopLevelClassCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/OneTopLevelClassCheck.java @@ -39,7 +39,7 @@ * public class, enum or interface, top-level type is the first type in file. *
*- * An example of check's configuration: + * To configure the check: *
** <module name="OneTopLevelClass"/> @@ -52,32 +52,32 @@ * An example of code with violations: * *- * public class Foo{ - * //methods + * public class Foo { // OK, first top-level class + * // methods * } * - * class Foo2{ - * //methods + * class Foo2 { // violation, second top-level class + * // methods * } *** An example of code without public top-level type: *
*- * class Foo{ // top-level class - * //methods + * class Foo { // OK, first top-level class + * // methods * } * - * class Foo2{ - * //methods + * class Foo2 { // violation, second top-level class + * // methods * } *** An example of code without violations: *
*- * public class Foo{ - * //methods + * public class Foo { // OK, only one top-level class + * // methods * } ** diff --git a/src/xdocs/config_design.xml b/src/xdocs/config_design.xml index aac86ae9cd6..38226ea2917 100644 --- a/src/xdocs/config_design.xml +++ b/src/xdocs/config_design.xml @@ -666,7 +666,7 @@ public class StringUtils // not final to allow subclassing- An example of check's configuration: + To configure the check: