<Swing Dev> RFR: 8263472: Specification of JComponent::updateUI doesn't mention that the original implementaiton does nothing [v3]
Alexey Ivanov
aivanov at openjdk.java.net
Tue Mar 16 12:29:11 UTC 2021
On Tue, 16 Mar 2021 12:17:49 GMT, Prasanta Sadhukhan <psadhukhan at openjdk.org> wrote:
>> src/java.desktop/share/classes/javax/swing/JComponent.java line 660:
>>
>>> 658: /**
>>> 659: * Resets the UI property to a value from the current look and feel.
>>> 660: * @implnote Since the default implementation of this method doesn't do anything,
>>
>> Suggestion:
>>
>> * @implNote Since the default implementation of this method doesn't do anything,
>> The correct tag is `@implNote` with capital N.
>
> It was suggested to use @implnote tag and I saw that couple of places in jdk repo, we used that in Unsafe.java and TrayIcon.java so I used that, although in majority of places, @implNote is used, so I thought maybe both can be used at our discretion.
> Anyway, will change to @implNote.
I understand it. I just built the docs to see how it looks and the text after `@implnote` was missing — it's absolutely wrong this way. With `@implNote`, the text is displayed below *Implementation Note:* sub-heading.
-------------
PR: https://git.openjdk.java.net/jdk/pull/2955
More information about the swing-dev
mailing list