[doc] CommentSize: mention the behavior change of #4369 explicitly

This commit is contained in:
Andreas Dangel
2023-04-27 10:49:26 +02:00
parent bd13b3915c
commit 8c8ba41b20
3 changed files with 8 additions and 2 deletions

View File

@ -278,6 +278,9 @@ Contributors: [Lucas Soncini](https://github.com/lsoncini) (@lsoncini),
* {% rule java/documentation/CommentContent %}: The properties `caseSensitive` and `disallowedTerms` are removed. The
new property `fobiddenRegex` can be used now to define the disallowed terms with a single regular
expression.
* {% rule java/documentation/CommentSize %}: When determining the line-length of a comment, the leading comment
prefix markers (e.g. `*` or `//`) are ignored and don't add up to the line-length.
See also [pull request #4369](https://github.com/pmd/pmd/pull/4369).
**Java Error Prone**

View File

@ -613,6 +613,9 @@ Related issue: [[core] Explicitly name all language versions (#4120)](https://gi
* {% rule java/documentation/CommentContent %}: The properties `caseSensitive` and `disallowedTerms` are removed. The
new property `fobiddenRegex` can be used now to define the disallowed terms with a single regular
expression.
* {% rule java/documentation/CommentSize %}: When determining the line-length of a comment, the leading comment
prefix markers (e.g. `*` or `//`) are ignored and don't add up to the line-length.
See also [pull request #4369](https://github.com/pmd/pmd/pull/4369).
**Java Error Prone**

View File

@ -29,7 +29,7 @@ public class Foo {
]]></code>
</test-code>
<test-code>
<description>Line too long</description>
<description>#4369 Line too long</description>
<rule-property name="maxLineLength">5</rule-property>
<expected-problems>1</expected-problems>
<expected-linenumbers>5</expected-linenumbers>
@ -37,7 +37,7 @@ public class Foo {
//
/* 4
/* 12345
* 5 way too long
*/
public class Foo {