diff --git a/config/checkstyle-non-main-files-suppressions.xml b/config/checkstyle-non-main-files-suppressions.xml index 1841005cfb0..5d8d32270b0 100644 --- a/config/checkstyle-non-main-files-suppressions.xml +++ b/config/checkstyle-non-main-files-suppressions.xml @@ -257,26 +257,6 @@ files="src[\\/]xdocs[\\/]checks[\\/]javadoc[\\/]javadocparagraph.xml.template"/> - - - - - - - - - - orderProperties(Set properties) { if (orderProperties.remove(TOKENS_PROPERTY)) { orderProperties.add(TOKENS_PROPERTY); } + if (orderProperties.remove(SiteUtil.JAVADOC_TOKENS)) { + orderProperties.add(SiteUtil.JAVADOC_TOKENS); + } return List.copyOf(orderProperties); } diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/site/SiteUtil.java b/src/main/java/com/puppycrawl/tools/checkstyle/site/SiteUtil.java index 036ece9e585..9e13f116bbf 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/site/SiteUtil.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/site/SiteUtil.java @@ -241,6 +241,8 @@ public final class SiteUtil { // until https://github.com/checkstyle/checkstyle/issues/14052 Map.entry("JavadocBlockTagLocationCheck.violateExecutionOnNonTightHtml", V824), Map.entry("JavadocMissingLeadingAsteriskCheck.violateExecutionOnNonTightHtml", "8.38"), + Map.entry( + "RequireEmptyLineBeforeBlockTagGroupCheck.violateExecutionOnNonTightHtml", "8.36"), Map.entry("ParenPadCheck.option", VERSION_3_0), Map.entry("TypecastParenPadCheck.option", VERSION_3_2), Map.entry("FileLengthCheck.fileExtensions", VERSION_5_0), diff --git a/src/xdocs/checks/javadoc/javadoctagcontinuationindentation.xml b/src/xdocs/checks/javadoc/javadoctagcontinuationindentation.xml index 6e8603228af..a8242303b14 100644 --- a/src/xdocs/checks/javadoc/javadoctagcontinuationindentation.xml +++ b/src/xdocs/checks/javadoc/javadoctagcontinuationindentation.xml @@ -38,13 +38,9 @@ violateExecutionOnNonTightHtml - - Control when to print violations if the Javadoc being examined by this check - violates the tight html rules defined at - Tight-HTML Rules. - - boolean - + Control when to print violations if the Javadoc being examined by this check violates the tight html rules defined at + Tight-HTML Rules. + boolean false 8.3 diff --git a/src/xdocs/checks/javadoc/javadoctagcontinuationindentation.xml.template b/src/xdocs/checks/javadoc/javadoctagcontinuationindentation.xml.template index b6ea1534970..cb73df07e00 100644 --- a/src/xdocs/checks/javadoc/javadoctagcontinuationindentation.xml.template +++ b/src/xdocs/checks/javadoc/javadoctagcontinuationindentation.xml.template @@ -21,34 +21,10 @@
- - - - - - - - - - - - - - - - - - - - - - -
namedescriptiontypedefault valuesince
offsetSpecify how many spaces to use for new indentation level.int46.0
violateExecutionOnNonTightHtml - Control when to print violations if the Javadoc being examined by this check - violates the tight html rules defined at - Tight-HTML Rules. - boolean - false8.3
+ + +
diff --git a/src/xdocs/checks/javadoc/javadoctype.xml b/src/xdocs/checks/javadoc/javadoctype.xml index 72195e7972f..d3a430076ca 100644 --- a/src/xdocs/checks/javadoc/javadoctype.xml +++ b/src/xdocs/checks/javadoc/javadoctype.xml @@ -48,8 +48,7 @@ allowMissingParamTags - Control whether to ignore violations when a class has type parameters - but does not have matching param tags in the Javadoc. + Control whether to ignore violations when a class has type parameters but does not have matching param tags in the Javadoc. boolean false 4.0 @@ -63,10 +62,7 @@ allowedAnnotations - - Specify annotations that allow skipping validation at all. - Only short names are allowed, e.g. Generated. - + Specify annotations that allow skipping validation at all. Only short names are allowed, e.g. Generated. String[] Generated 8.15 @@ -102,31 +98,30 @@ tokens tokens to check - - subset of tokens + subset of tokens - INTERFACE_DEF + INTERFACE_DEF , - CLASS_DEF + CLASS_DEF , - ENUM_DEF + ENUM_DEF , - ANNOTATION_DEF - , - RECORD_DEF + ANNOTATION_DEF + , + RECORD_DEF . - INTERFACE_DEF + INTERFACE_DEF , - CLASS_DEF + CLASS_DEF , - ENUM_DEF + ENUM_DEF , - ANNOTATION_DEF - , - RECORD_DEF + ANNOTATION_DEF + , + RECORD_DEF . 3.0 diff --git a/src/xdocs/checks/javadoc/javadoctype.xml.template b/src/xdocs/checks/javadoc/javadoctype.xml.template index ab8ad9d0dcd..71a8ff08c97 100644 --- a/src/xdocs/checks/javadoc/javadoctype.xml.template +++ b/src/xdocs/checks/javadoc/javadoctype.xml.template @@ -38,100 +38,10 @@
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
namedescriptiontypedefault valuesince
allowMissingParamTagsControl whether to ignore violations when a class has type parameters - but does not have matching param tags in the Javadoc.booleanfalse4.0
allowUnknownTagsControl whether to ignore violations when a Javadoc tag is not recognised.booleanfalse5.1
allowedAnnotations - Specify annotations that allow skipping validation at all. - Only short names are allowed, e.g. Generated. - String[]Generated8.15
authorFormatSpecify the pattern for @author tag.Patternnull3.0
excludeScopeSpecify the visibility scope where Javadoc comments are not checked.Scopenull3.4
scopeSpecify the visibility scope where Javadoc comments are checked.Scopeprivate3.0
versionFormatSpecify the pattern for @version tag.Patternnull3.0
tokenstokens to check - subset of tokens - - INTERFACE_DEF - , - CLASS_DEF - , - ENUM_DEF - , - ANNOTATION_DEF - , - RECORD_DEF - . - - - INTERFACE_DEF - , - CLASS_DEF - , - ENUM_DEF - , - ANNOTATION_DEF - , - RECORD_DEF - . - 3.0
+ + +
diff --git a/src/xdocs/checks/javadoc/javadocvariable.xml b/src/xdocs/checks/javadoc/javadocvariable.xml index ede9bd78664..19d0723679c 100644 --- a/src/xdocs/checks/javadoc/javadocvariable.xml +++ b/src/xdocs/checks/javadoc/javadocvariable.xml @@ -51,14 +51,12 @@ tokens to check subset of tokens - ENUM_CONSTANT_DEF - + ENUM_CONSTANT_DEF . - ENUM_CONSTANT_DEF - + ENUM_CONSTANT_DEF . 3.0 diff --git a/src/xdocs/checks/javadoc/javadocvariable.xml.template b/src/xdocs/checks/javadoc/javadocvariable.xml.template index 74e1af17a50..8d8341a6375 100644 --- a/src/xdocs/checks/javadoc/javadocvariable.xml.template +++ b/src/xdocs/checks/javadoc/javadocvariable.xml.template @@ -17,53 +17,10 @@
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
namedescriptiontypedefault valuesince
excludeScopeSpecify the visibility scope where Javadoc comments are not checked.Scopenull3.4
ignoreNamePatternSpecify the regexp to define variable names to ignore.Patternnull5.8
scopeSpecify the visibility scope where Javadoc comments are checked.Scopeprivate3.0
tokenstokens to checksubset of tokens - - ENUM_CONSTANT_DEF - - . - - - ENUM_CONSTANT_DEF - - . - 3.0
+ + +
diff --git a/src/xdocs/checks/javadoc/missingjavadocmethod.xml b/src/xdocs/checks/javadoc/missingjavadocmethod.xml index 02b57c95314..791e85ff5d3 100644 --- a/src/xdocs/checks/javadoc/missingjavadocmethod.xml +++ b/src/xdocs/checks/javadoc/missingjavadocmethod.xml @@ -61,10 +61,7 @@ public boolean isSomething() allowMissingPropertyJavadoc - - Control whether to allow missing Javadoc on accessor methods for - properties (setters and getters). - + Control whether to allow missing Javadoc on accessor methods for properties (setters and getters). boolean false 8.21 @@ -107,28 +104,26 @@ public boolean isSomething() tokens tokens to check - - - subset of tokens + subset of tokens - METHOD_DEF + METHOD_DEF , - CTOR_DEF + CTOR_DEF , - ANNOTATION_FIELD_DEF + ANNOTATION_FIELD_DEF , - COMPACT_CTOR_DEF + COMPACT_CTOR_DEF . - METHOD_DEF + METHOD_DEF , - CTOR_DEF + CTOR_DEF , - ANNOTATION_FIELD_DEF + ANNOTATION_FIELD_DEF , - COMPACT_CTOR_DEF + COMPACT_CTOR_DEF . 8.21 diff --git a/src/xdocs/checks/javadoc/missingjavadocmethod.xml.template b/src/xdocs/checks/javadoc/missingjavadocmethod.xml.template index 1dc7aa9e74c..962559b6a09 100644 --- a/src/xdocs/checks/javadoc/missingjavadocmethod.xml.template +++ b/src/xdocs/checks/javadoc/missingjavadocmethod.xml.template @@ -51,89 +51,10 @@ public boolean isSomething()
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
namedescriptiontypedefault valuesince
allowMissingPropertyJavadoc - Control whether to allow missing Javadoc on accessor methods for - properties (setters and getters). - booleanfalse8.21
allowedAnnotationsConfigure annotations that allow missed documentation.String[]Override8.21
excludeScopeSpecify the visibility scope where Javadoc comments are not checked.Scopenull8.21
ignoreMethodNamesRegexIgnore method whose names are matching specified regex.Patternnull8.21
minLineCountControl the minimal amount of lines in method to allow no documentation.int-18.21
scopeSpecify the visibility scope where Javadoc comments are checked.Scopepublic8.21
tokenstokens to check - subset of tokens - - METHOD_DEF - , - CTOR_DEF - , - ANNOTATION_FIELD_DEF - , - COMPACT_CTOR_DEF - . - - - METHOD_DEF - , - CTOR_DEF - , - ANNOTATION_FIELD_DEF - , - COMPACT_CTOR_DEF - . - 8.21
+ + +
diff --git a/src/xdocs/checks/javadoc/missingjavadoctype.xml b/src/xdocs/checks/javadoc/missingjavadoctype.xml index c4c73d332a8..638d20b1996 100644 --- a/src/xdocs/checks/javadoc/missingjavadoctype.xml +++ b/src/xdocs/checks/javadoc/missingjavadoctype.xml @@ -44,11 +44,7 @@ skipAnnotations - - Specify annotations that allow missed documentation. - If annotation is present in target sources in multiple forms of qualified - name, all forms should be listed in this property. - + Specify annotations that allow missed documentation. If annotation is present in target sources in multiple forms of qualified name, all forms should be listed in this property. String[] Generated 8.20 @@ -56,31 +52,30 @@ tokens tokens to check - - subset of tokens + subset of tokens - INTERFACE_DEF + INTERFACE_DEF , - CLASS_DEF + CLASS_DEF , - ENUM_DEF + ENUM_DEF , - ANNOTATION_DEF + ANNOTATION_DEF , - RECORD_DEF + RECORD_DEF . - INTERFACE_DEF + INTERFACE_DEF , - CLASS_DEF + CLASS_DEF , - ENUM_DEF + ENUM_DEF , - ANNOTATION_DEF + ANNOTATION_DEF , - RECORD_DEF + RECORD_DEF . 8.20 diff --git a/src/xdocs/checks/javadoc/missingjavadoctype.xml.template b/src/xdocs/checks/javadoc/missingjavadoctype.xml.template index fa0c58215b2..30b38a49683 100644 --- a/src/xdocs/checks/javadoc/missingjavadoctype.xml.template +++ b/src/xdocs/checks/javadoc/missingjavadoctype.xml.template @@ -20,72 +20,10 @@
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
namedescriptiontypedefault valuesince
excludeScopeSpecify the visibility scope where Javadoc comments are not checked.Scopenull8.20
scopeSpecify the visibility scope where Javadoc comments are checked.Scopepublic8.20
skipAnnotations - Specify annotations that allow missed documentation. - If annotation is present in target sources in multiple forms of qualified - name, all forms should be listed in this property. - String[]Generated8.20
tokenstokens to check - subset of tokens - - INTERFACE_DEF - , - CLASS_DEF - , - ENUM_DEF - , - ANNOTATION_DEF - , - RECORD_DEF - . - - - INTERFACE_DEF - , - CLASS_DEF - , - ENUM_DEF - , - ANNOTATION_DEF - , - RECORD_DEF - . - 8.20
+ + +
diff --git a/src/xdocs/checks/javadoc/nonemptyatclausedescription.xml b/src/xdocs/checks/javadoc/nonemptyatclausedescription.xml index 01472b878d7..c2bdb8d25e8 100644 --- a/src/xdocs/checks/javadoc/nonemptyatclausedescription.xml +++ b/src/xdocs/checks/javadoc/nonemptyatclausedescription.xml @@ -26,11 +26,8 @@ violateExecutionOnNonTightHtml - - Control when to print violations if the Javadoc being examined by this check - violates the tight html rules defined at - Tight-HTML Rules. - + Control when to print violations if the Javadoc being examined by this check violates the tight html rules defined at + Tight-HTML Rules. boolean false 8.3 @@ -40,28 +37,28 @@ javadoc tokens to check subset of javadoc tokens - PARAM_LITERAL + PARAM_LITERAL , - RETURN_LITERAL + RETURN_LITERAL , - THROWS_LITERAL + THROWS_LITERAL , - EXCEPTION_LITERAL + EXCEPTION_LITERAL , - DEPRECATED_LITERAL + DEPRECATED_LITERAL . - PARAM_LITERAL + PARAM_LITERAL , - RETURN_LITERAL + RETURN_LITERAL , - THROWS_LITERAL + THROWS_LITERAL , - EXCEPTION_LITERAL + EXCEPTION_LITERAL , - DEPRECATED_LITERAL + DEPRECATED_LITERAL . 7.3 diff --git a/src/xdocs/checks/javadoc/nonemptyatclausedescription.xml.template b/src/xdocs/checks/javadoc/nonemptyatclausedescription.xml.template index 8a499d9006b..61a5249495f 100644 --- a/src/xdocs/checks/javadoc/nonemptyatclausedescription.xml.template +++ b/src/xdocs/checks/javadoc/nonemptyatclausedescription.xml.template @@ -16,57 +16,10 @@
- - - - - - - - - - - - - - - - - - - - - - -
namedescriptiontypedefault valuesince
violateExecutionOnNonTightHtml - Control when to print violations if the Javadoc being examined by this check - violates the tight html rules defined at - Tight-HTML Rules. - booleanfalse8.3
javadocTokensjavadoc tokens to checksubset of javadoc tokens - - PARAM_LITERAL - , - RETURN_LITERAL - , - THROWS_LITERAL - , - EXCEPTION_LITERAL - , - DEPRECATED_LITERAL - . - - - PARAM_LITERAL - , - RETURN_LITERAL - , - THROWS_LITERAL - , - EXCEPTION_LITERAL - , - DEPRECATED_LITERAL - . - 7.3
+ + +
diff --git a/src/xdocs/checks/javadoc/requireemptylinebeforeblocktaggroup.xml b/src/xdocs/checks/javadoc/requireemptylinebeforeblocktaggroup.xml index f8812f8ec4f..dc42d2fb964 100644 --- a/src/xdocs/checks/javadoc/requireemptylinebeforeblocktaggroup.xml +++ b/src/xdocs/checks/javadoc/requireemptylinebeforeblocktaggroup.xml @@ -13,6 +13,7 @@ Checks that one blank line before the block tag if it is present in Javadoc.

+
@@ -25,11 +26,8 @@ - + diff --git a/src/xdocs/checks/javadoc/requireemptylinebeforeblocktaggroup.xml.template b/src/xdocs/checks/javadoc/requireemptylinebeforeblocktaggroup.xml.template index 3dbc673be44..c75910cf8b6 100644 --- a/src/xdocs/checks/javadoc/requireemptylinebeforeblocktaggroup.xml.template +++ b/src/xdocs/checks/javadoc/requireemptylinebeforeblocktaggroup.xml.template @@ -13,28 +13,13 @@ Checks that one blank line before the block tag if it is present in Javadoc.

+
-
violateExecutionOnNonTightHtml - Control when to print violations if the Javadoc being examined by this check - violates the tight html rules defined at - Tight-HTML Rules. - Control when to print violations if the Javadoc being examined by this check violates the tight html rules defined at + Tight-HTML Rules. boolean false 8.36
- - - - - - - - - - - - - - -
namedescriptiontypedefault valuesince
violateExecutionOnNonTightHtml - Control when to print violations if the Javadoc being examined by this check - violates the tight html rules defined at - Tight-HTML Rules. - booleanfalse8.36
+ + +
diff --git a/src/xdocs/checks/javadoc/singlelinejavadoc.xml b/src/xdocs/checks/javadoc/singlelinejavadoc.xml index fef87e8e155..a1bacb7f072 100644 --- a/src/xdocs/checks/javadoc/singlelinejavadoc.xml +++ b/src/xdocs/checks/javadoc/singlelinejavadoc.xml @@ -28,33 +28,24 @@ ignoreInlineTags - - Control whether - - inline tags must be ignored. - + Control whether + inline tags must be ignored. boolean true 6.8 ignoredTags - - Specify - - block tags which are ignored by the check. - + Specify + block tags which are ignored by the check. String[] {} 6.8 violateExecutionOnNonTightHtml - - Control when to print violations if the Javadoc being examined by this check - violates the tight html rules defined at - Tight-HTML Rules. - + Control when to print violations if the Javadoc being examined by this check violates the tight html rules defined at + Tight-HTML Rules. boolean false 8.3 diff --git a/src/xdocs/checks/javadoc/singlelinejavadoc.xml.template b/src/xdocs/checks/javadoc/singlelinejavadoc.xml.template index 9df0543a055..0bca2384b10 100644 --- a/src/xdocs/checks/javadoc/singlelinejavadoc.xml.template +++ b/src/xdocs/checks/javadoc/singlelinejavadoc.xml.template @@ -18,48 +18,10 @@
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
namedescriptiontypedefault valuesince
ignoreInlineTags - Control whether - - inline tags must be ignored. - booleantrue6.8
ignoredTags - Specify - - block tags which are ignored by the check. - String[]{}6.8
violateExecutionOnNonTightHtml - Control when to print violations if the Javadoc being examined by this check - violates the tight html rules defined at - Tight-HTML Rules. - booleanfalse8.3
+ + +
diff --git a/src/xdocs/checks/javadoc/summaryjavadoc.xml b/src/xdocs/checks/javadoc/summaryjavadoc.xml index 0564ed67d5d..a4177a0cbb6 100644 --- a/src/xdocs/checks/javadoc/summaryjavadoc.xml +++ b/src/xdocs/checks/javadoc/summaryjavadoc.xml @@ -46,11 +46,8 @@ violateExecutionOnNonTightHtml - - Control when to print violations if the Javadoc being examined by this check - violates the tight html rules defined at - Tight-HTML Rules. - + Control when to print violations if the Javadoc being examined by this check violates the tight html rules defined at + Tight-HTML Rules. boolean false 8.3 diff --git a/src/xdocs/checks/javadoc/summaryjavadoc.xml.template b/src/xdocs/checks/javadoc/summaryjavadoc.xml.template index 2ab5991c86a..8f68c4390e5 100644 --- a/src/xdocs/checks/javadoc/summaryjavadoc.xml.template +++ b/src/xdocs/checks/javadoc/summaryjavadoc.xml.template @@ -22,40 +22,10 @@
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
namedescriptiontypedefault valuesince
forbiddenSummaryFragmentsSpecify the regexp for forbidden summary fragments.Pattern"^$"6.0
periodSpecify the period symbol at the end of first javadoc sentence.String"."6.2
violateExecutionOnNonTightHtml - Control when to print violations if the Javadoc being examined by this check - violates the tight html rules defined at - Tight-HTML Rules. - booleanfalse8.3
+ + +
diff --git a/src/xdocs/checks/javadoc/writetag.xml b/src/xdocs/checks/javadoc/writetag.xml index 4faf30fbe67..34c1137593b 100644 --- a/src/xdocs/checks/javadoc/writetag.xml +++ b/src/xdocs/checks/javadoc/writetag.xml @@ -52,38 +52,38 @@ tokens to check subset of tokens - INTERFACE_DEF + INTERFACE_DEF , - CLASS_DEF + CLASS_DEF , - ENUM_DEF + ENUM_DEF , - ANNOTATION_DEF + ANNOTATION_DEF , - METHOD_DEF + METHOD_DEF , - CTOR_DEF + CTOR_DEF , - ENUM_CONSTANT_DEF + ENUM_CONSTANT_DEF , - ANNOTATION_FIELD_DEF - , - RECORD_DEF - , - COMPACT_CTOR_DEF + ANNOTATION_FIELD_DEF + , + RECORD_DEF + , + COMPACT_CTOR_DEF . - INTERFACE_DEF + INTERFACE_DEF , - CLASS_DEF + CLASS_DEF , - ENUM_DEF + ENUM_DEF , - ANNOTATION_DEF - , - RECORD_DEF + ANNOTATION_DEF + , + RECORD_DEF . 4.2 diff --git a/src/xdocs/checks/javadoc/writetag.xml.template b/src/xdocs/checks/javadoc/writetag.xml.template index 9a2d0d0c872..ef21afe6071 100644 --- a/src/xdocs/checks/javadoc/writetag.xml.template +++ b/src/xdocs/checks/javadoc/writetag.xml.template @@ -18,77 +18,10 @@
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
namedescriptiontypedefault valuesince
tagSpecify the name of tag.Stringnull4.2
tagFormatSpecify the regexp to match tag content.Patternnull4.2
tagSeveritySpecify the severity level when tag is found and printed.SeverityLevelinfo4.2
tokenstokens to checksubset of tokens - - INTERFACE_DEF - , - CLASS_DEF - , - ENUM_DEF - , - ANNOTATION_DEF - , - METHOD_DEF - , - CTOR_DEF - , - ENUM_CONSTANT_DEF - , - ANNOTATION_FIELD_DEF - , - RECORD_DEF - , - COMPACT_CTOR_DEF - . - - - INTERFACE_DEF - , - CLASS_DEF - , - ENUM_DEF - , - ANNOTATION_DEF - , - RECORD_DEF - . - 4.2
+ + +