<Swing Dev> RFR: 8265291: Error in Javadoc for doAccessibleAction API in AccessibleJSlider class

Alexander Zvegintsev azvegint at openjdk.java.net
Mon May 3 18:28:56 UTC 2021


On Mon, 3 May 2021 17:09:59 GMT, Pankaj Bansal <pbansal at openjdk.org> wrote:

> > 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.

-------------

PR: https://git.openjdk.java.net/jdk/pull/3832


More information about the swing-dev mailing list