8301813: Bad caret position in error message

[jonathan-gibbons]

Please review a trivial update to DocCommentParser and corresponding updates to tests, to fix the caret position in the two forms of the "no tag name found" error message.

The fix is simply to use the overload of erroneous that allows the preferred caret position to be specified. This overload was not available at the time the affected lines were originally written.

The "natural" place to test this is in the doctree tests (that is, TagTest.java) but that test is not set up for easy monitoring of the end-user visible caret, so a new doclet test is created for that. (TestNoTagName.java).

BadPackageCommentTest.java is also affected. It is updated in a manner similar to that in a parallel PR for handling at-escapes. However, the changed caret position will eventually probably cause a minor change conflict that will need to be resolved.

---

Progress

• Change must be properly reviewed (1 review required, with at least 1 Reviewer)
• Change must not contain extraneous whitespace
• Commit message must refer to an issue

Issue

• JDK-8301813: Bad caret position in error message

Reviewers

• Iris Clark (@irisclark - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk pull/12421/head:pull/12421
$ git checkout pull/12421

Update a local copy of the PR:
$ git checkout pull/12421
$ git pull https://git.openjdk.org/jdk pull/12421/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 12421

View PR using the GUI difftool:
$ git pr show -t 12421

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/12421.diff

[bridgekeeper]

👋 Welcome back jjg! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

[openjdk]

@jonathan-gibbons The following labels will be automatically applied to this pull request:

• compiler
• javadoc

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing lists. If you would like to change these labels, use the /label pull request command.

[mlbridge]

Webrevs

• 00: Full (372760c5)

[openjdk]

@jonathan-gibbons This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8301813: Bad caret position in error message

Reviewed-by: iris

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 23 new commits pushed to the master branch:

• b569742: 8301788: AlgorithmId should keep lowercase characters from 3rd party providers
• 05ea083: 8301167: Update VerifySignedJar to actually exercise and test verification
• ecf8842: 8300098: java/util/concurrent/ConcurrentHashMap/ConcurrentAssociateTest.java fails with internal timeout when executed with TieredCompilation1/3
• 7ae447f: 8301095: [s390x] TestDwarf.java fails
• 9c80b8a: 8299683: [S390X] Problems with -XX:+VerifyStack
• 8e9b726: 8301599: Serial: Refactor nested closures in DefNewGeneration
• 7730506: 8299162: Refactor shared trampoline emission logic
• 522fa13: 8301580: Error recovery does not clear returnResult
• 7ac2079: 8301025: ClassCastException in switch with generic record
• 371a0c4: 8301465: Remove unnecessary nmethod arming in Full GC of Serial/Parallel
• ... and 13 more: https://git.openjdk.org/jdk/compare/e7247b10ccd2bf1ad6809395a1b63aa5046d5b1d...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

[jonathan-gibbons]

/integrate

[openjdk]

Going to push as commit d53ade1.
Since your change was applied there have been 25 commits pushed to the master branch:

• 8c01b6e: 8221580: Confusing diagnostic for assigning a static final field in a constructor
• c129ce4: 8300259: Add test coverage for processing of pending block files in signed JARs
• b569742: 8301788: AlgorithmId should keep lowercase characters from 3rd party providers
• 05ea083: 8301167: Update VerifySignedJar to actually exercise and test verification
• ecf8842: 8300098: java/util/concurrent/ConcurrentHashMap/ConcurrentAssociateTest.java fails with internal timeout when executed with TieredCompilation1/3
• 7ae447f: 8301095: [s390x] TestDwarf.java fails
• 9c80b8a: 8299683: [S390X] Problems with -XX:+VerifyStack
• 8e9b726: 8301599: Serial: Refactor nested closures in DefNewGeneration
• 7730506: 8299162: Refactor shared trampoline emission logic
• 522fa13: 8301580: Error recovery does not clear returnResult
• ... and 15 more: https://git.openjdk.org/jdk/compare/e7247b10ccd2bf1ad6809395a1b63aa5046d5b1d...master

Your commit was automatically rebased without conflicts.

[openjdk]

@jonathan-gibbons Pushed as commit d53ade1.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.