8265291: Error in Javadoc for doAccessibleAction API in AccessibleJSlider class

[pankaj-bansal]

There is a small error in javadoc for doAccessibleAction function added in AccessibleJSlider class under JDK-8262981. The documentation says that the API returns true always, whereas it can return both true or false depending upon the parameter value, same as is the case with same API in AccessibleJSpinner. This error happened do to an oversight and current fix corrects the error.

---

Progress

• Change must not contain extraneous whitespace
• Commit message must refer to an issue
• Change must be properly reviewed

Issue

• JDK-8265291: Error in Javadoc for doAccessibleAction API in AccessibleJSlider class

Reviewers

• Alexander Zvegintsev (@azvegint - Reviewer)
• Jayathirth D V (@jayathirthrao - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/jdk pull/3832/head:pull/3832
$ git checkout pull/3832

Update a local copy of the PR:
$ git checkout pull/3832
$ git pull https://git.openjdk.java.net/jdk pull/3832/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 3832

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.java.net/jdk/pull/3832.diff

[bridgekeeper]

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

@pankaj-bansal The following label will be automatically applied to this pull request:

• swing

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

[mlbridge]

Webrevs

• 00: Full (d485e1d0)

[azvegint]

Looks like it requires CSR.

[openjdk]

@pankaj-bansal 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:

8265291: Error in Javadoc for doAccessibleAction API in AccessibleJSlider class

Reviewed-by: azvegint, jdv

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 139 new commits pushed to the master branch:

• 0790e60: 8196743: jstatd doesn't see new Java processes inside Docker container
• c6aa8f1: 8232644: bugs in serialized-form.html
• b5b3119: 8266589: (fs) Improve performance of Files.copy() on macOS using copyfile(3)
• 947d69d: 8265042: javadoc HTML files not generated for types nested in records
• 946b0fe: 8266645: javac should not check for sealed supertypes in intersection types
• 74fecc0: 8266503: [UL] Make Decorations safely copy-able and reduce their size
• 86b8dc9: 8265426: Update java.security to use instanceof pattern variable
• 3fcdc50: 8266646: Add more diagnostic to java/lang/System/LoggerFinder/modules
• 9a19a0c: 8264760: JVM crashes when two threads encounter the same resolution error
• 14f0afe: 8214237: Join parallel phases post evacuation
• ... and 129 more: https://git.openjdk.java.net/jdk/compare/91226fa12247765f53469ad8db02db7b7b23aaf1...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.

[pankaj-bansal]

Looks like it requires CSR.

I think CSR is not required in this case. CSR would have been required if return type was being changed. Here the change only says that the function can return both true or false instead of just true, but the return type is not being changed. I will try to get clarity on this and proceed accordingly.

[azvegint]

Looks like it requires CSR.

I think CSR is not required in this case. CSR would have been required if return type was being changed. Here the change only says that the function can return both true or false instead of just true, but the return type is not being changed. I will try to get clarity on this and proceed accordingly.

https://wiki.openjdk.java.net/display/csr/CSR+FAQs:

Q: If the text of the javadoc of a public exported API is changing, is a CSR request needed?
A: A CSR request is required if the specification of a public exported API. Not all javadoc updates are specification changes. For example, typo fixes and rephrasings that do not alter the semantics of the API in question do not require CSR review.

It looks like a javadoc which alters semantics of the API.
This method can be used in subclass and probably would count as public exported API, but I am not sure here.

[jayathirthrao]

It is a behavioral change from Javadoc and it needs CSR.

[jayathirthrao]

/csr needed

[openjdk]

@jayathirthrao has indicated that a compatibility and specification (CSR) request is needed for this pull request.
@pankaj-bansal please create a CSR request for issue JDK-8265291. This pull request cannot be integrated until the CSR request is approved.

[pankaj-bansal]

/integrate

[openjdk]

@pankaj-bansal Since your change was applied there have been 142 commits pushed to the master branch:

• be4f25b: 8266369: (se) Add wepoll based Selector
• ff77ca8: 8266675: Optimize IntHashTable for encapsulation and ease of use
• 04fad70: 8266765: [BACKOUT] JDK-8255493 Support for pre-generated java.lang.invoke classes in CDS dynamic archive
• 0790e60: 8196743: jstatd doesn't see new Java processes inside Docker container
• c6aa8f1: 8232644: bugs in serialized-form.html
• b5b3119: 8266589: (fs) Improve performance of Files.copy() on macOS using copyfile(3)
• 947d69d: 8265042: javadoc HTML files not generated for types nested in records
• 946b0fe: 8266645: javac should not check for sealed supertypes in intersection types
• 74fecc0: 8266503: [UL] Make Decorations safely copy-able and reduce their size
• 86b8dc9: 8265426: Update java.security to use instanceof pattern variable
• ... and 132 more: https://git.openjdk.java.net/jdk/compare/91226fa12247765f53469ad8db02db7b7b23aaf1...master

Your commit was automatically rebased without conflicts.

Pushed as commit 3af4efd.

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