diff --git a/config/checkstyle-non-main-files-suppressions.xml b/config/checkstyle-non-main-files-suppressions.xml index 5d8d32270b0..50432da1eaf 100644 --- a/config/checkstyle-non-main-files-suppressions.xml +++ b/config/checkstyle-non-main-files-suppressions.xml @@ -253,10 +253,6 @@ - - allowNewlineParagraph - - Control whether the <p> tag should be placed immediately before the first - word. - + Control whether the <p> tag should be placed immediately before the first word. boolean true 6.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. - + 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/javadocparagraph.xml.template b/src/xdocs/checks/javadoc/javadocparagraph.xml.template index 8d0bffae3b5..183adbd6ea2 100644 --- a/src/xdocs/checks/javadoc/javadocparagraph.xml.template +++ b/src/xdocs/checks/javadoc/javadocparagraph.xml.template @@ -28,36 +28,10 @@
- - - - - - - - - - - - - - - - - - - - - - -
namedescriptiontypedefault valuesince
allowNewlineParagraph - Control whether the <p> tag should be placed immediately before the first - word. - booleantrue6.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. - booleanfalse8.3
+ + +
diff --git a/src/xdocs/checks/javadoc/javadocstyle.xml b/src/xdocs/checks/javadoc/javadocstyle.xml index 86dbb404c66..ee47cda2922 100644 --- a/src/xdocs/checks/javadoc/javadocstyle.xml +++ b/src/xdocs/checks/javadoc/javadocstyle.xml @@ -74,18 +74,14 @@ checkEmptyJavadoc - - Control whether to check if the Javadoc is missing a describing text. - + Control whether to check if the Javadoc is missing a describing text. boolean false 3.4 checkFirstSentence - - Control whether to check the first sentence for proper end of sentence. - + Control whether to check the first sentence for proper end of sentence. boolean true 3.2 @@ -99,9 +95,7 @@ endOfSentenceFormat - - Specify the format for matching the end of a sentence. - + Specify the format for matching the end of a sentence. Pattern "([.?!][ \t\n\r\f<])|([.?!]$)" 5.0 @@ -125,56 +119,56 @@ tokens to check subset of tokens - ANNOTATION_DEF + ANNOTATION_DEF , - ANNOTATION_FIELD_DEF + ANNOTATION_FIELD_DEF , - CLASS_DEF + CLASS_DEF , - CTOR_DEF + CTOR_DEF , - ENUM_CONSTANT_DEF + ENUM_CONSTANT_DEF , - ENUM_DEF + ENUM_DEF , - INTERFACE_DEF + INTERFACE_DEF , - METHOD_DEF + METHOD_DEF , - PACKAGE_DEF + PACKAGE_DEF , - VARIABLE_DEF - , - RECORD_DEF - , - COMPACT_CTOR_DEF + VARIABLE_DEF + , + RECORD_DEF + , + COMPACT_CTOR_DEF . - ANNOTATION_DEF + ANNOTATION_DEF , - ANNOTATION_FIELD_DEF + ANNOTATION_FIELD_DEF , - CLASS_DEF + CLASS_DEF , - CTOR_DEF + CTOR_DEF , - ENUM_CONSTANT_DEF + ENUM_CONSTANT_DEF , - ENUM_DEF + ENUM_DEF , - INTERFACE_DEF + INTERFACE_DEF , - METHOD_DEF + METHOD_DEF , - PACKAGE_DEF + PACKAGE_DEF , - VARIABLE_DEF - , - RECORD_DEF - , - COMPACT_CTOR_DEF + VARIABLE_DEF + , + RECORD_DEF + , + COMPACT_CTOR_DEF . 3.2 diff --git a/src/xdocs/checks/javadoc/javadocstyle.xml.template b/src/xdocs/checks/javadoc/javadocstyle.xml.template index fe2bf6e992f..15d61df67cf 100644 --- a/src/xdocs/checks/javadoc/javadocstyle.xml.template +++ b/src/xdocs/checks/javadoc/javadocstyle.xml.template @@ -64,122 +64,10 @@
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
namedescriptiontypedefault valuesince
checkEmptyJavadoc - Control whether to check if the Javadoc is missing a describing text. - booleanfalse3.4
checkFirstSentence - Control whether to check the first sentence for proper end of sentence. - booleantrue3.2
checkHtmlControl whether to check for incomplete HTML tags.booleantrue3.2
endOfSentenceFormat - Specify the format for matching the end of a sentence. - Pattern"([.?!][ \t\n\r\f<])|([.?!]$)"5.0
excludeScopeSpecify the visibility scope where Javadoc comments are not checked.Scopenull3.4
scopeSpecify the visibility scope where Javadoc comments are checked.Scopeprivate3.2
tokenstokens to checksubset of tokens - - ANNOTATION_DEF - , - ANNOTATION_FIELD_DEF - , - CLASS_DEF - , - CTOR_DEF - , - ENUM_CONSTANT_DEF - , - ENUM_DEF - , - INTERFACE_DEF - , - METHOD_DEF - , - PACKAGE_DEF - , - VARIABLE_DEF - , - RECORD_DEF - , - COMPACT_CTOR_DEF - . - - - ANNOTATION_DEF - , - ANNOTATION_FIELD_DEF - , - CLASS_DEF - , - CTOR_DEF - , - ENUM_CONSTANT_DEF - , - ENUM_DEF - , - INTERFACE_DEF - , - METHOD_DEF - , - PACKAGE_DEF - , - VARIABLE_DEF - , - RECORD_DEF - , - COMPACT_CTOR_DEF - . - 3.2
+ + +