Issue #14689: Prevent false positives when first sentence of Javadoc is on its own line

[patchwork01]

Resolves: #14689
Resolves: #14750
Resolves: #14751

Handle cases where first sentence of Javadoc is on its own line.

Handle cases where first sentence of Javadoc includes a period character without whitespace after it.

Diff Regression config: https://gist.githubusercontent.com/patchwork01/d62651d8467212daf75aff8100e813c1/raw/ac03b5b7fbcbee95f7508e40462ce97d72dfc550/my_check.xml

[romani]

please squash all in single commit

[patchwork01]

please squash all in single commit

Done

[romani]

thanks a lot for fix.

first shallow dive in PR:

[romani]

@patchwork01, please resolve Checker and Pitest failures.

[romani]

Items

[romani]

please review if we can avoid this: https://github.com/checkstyle/checkstyle/actions/runs/8466706931/job/23196469563?pr=14690#step:6:933

New surviving error(s) found:

  <checkerFrameworkError unstable="false">
    <fileName>src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/SummaryJavadocCheck.java</fileName>
    <specifier>argument</specifier>
    <message>incompatible argument for parameter end of StringBuilder.append.</message>
    <lineContent>result.append(text, 0, periodIndex);</lineContent>
    <details>
      found   : int
      required: @LTEqLengthOf(&quot;text&quot;) int
    </details>
  </checkerFrameworkError>

if not, just run groovy ./.ci/checker-framework.groovy checker-index on your local and add generated update/change to suppression file to your PR. It will be red flag for each reviewer, so better to share reasons why we cannot fix it, or it is not reasonable, or ... .

[romani]

last testing request, please read https://github.com/checkstyle/contribution/tree/master/checkstyle-tester#basic-difference-report-with-custom-projects-list and provide such two configs and lets test on bunch of real code. Result will be diff report, we need o make sure there is not unexpected regressions.

[patchwork01]

please review if we can avoid this: https://github.com/checkstyle/checkstyle/actions/runs/8466706931/job/23196469563?pr=14690#step:6:933

That's fixed now.

last testing request, please read https://github.com/checkstyle/contribution/tree/master/checkstyle-tester#basic-difference-report-with-custom-projects-list and provide such two configs and lets test on bunch of real code. Result will be diff report, we need o make sure there is not unexpected regressions.

I'm not sure what you mean. What do you want me to do?

[romani]

please read https://github.com/checkstyle/contribution/tree/master/checkstyle-tester#executing-generation

Example configuration in PR description and triggering for different Check - #14743

[patchwork01]

GitHub, generate report

[github-actions]

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/9a336b9_2024113540/index.html

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/9a336b9_2024113540/checks/javadoc/summaryjavadoc.html#Properties

[nrmancuso]

First pass:

[romani]

To fix CI please rebase on latest

[nrmancuso]

Last from me:

[nrmancuso]

Big improvement, thanks a lot @patchwork01 !!

Edit: looks like we did not generate a regression report on the latest code, let's make sure we are good before merging.

[nrmancuso]

Github, generate report

[github-actions]

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/3043b4f_2024161246/reports/diff/index.html