7904080: APIDiff does not detect javadoc (and changes to javadoc) for methods with varargs

[lahodaj]

The keys in the HTML Javadoc for methods with varargs use ..., but the signatures generated by API Diff use [], so API Diff cannot find the appropriate javadoc in the HTML for vararg methods, which leads to a failure to show the differences in the javadoc for such methods.

There are multiple possible ways to fix that, but the proposal herein is to try to normalize the keys to use [] while reading the HTML.

---

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

• CODETOOLS-7904080: APIDiff does not detect javadoc (and changes to javadoc) for methods with varargs (Bug - P3)

Reviewers

• Christian Stein (@sormuras - Reviewer)
• Iris Clark (@irisclark - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 31

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/apidiff/pull/31.diff

Using Webrev

Link to Webrev Comment

[bridgekeeper]

👋 Welcome back jlahoda! 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]

@lahodaj 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:

7904080: APIDiff does not detect javadoc (and changes to javadoc) for methods with varargs

Reviewed-by: cstein, 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 no new commits pushed to the master branch. If another commit should be pushed before you perform the /integrate command, your PR will be automatically rebased. If you prefer to avoid any potential 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.

[mlbridge]

Webrevs

• 00: Full (d4e7beef)

[irisclark]

Thanks for fixing this!

[lahodaj]

/integrate

[openjdk]

Going to push as commit 80d071c.

[openjdk]

@lahodaj Pushed as commit 80d071c.

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