<Swing Dev> RFR: 8264218: Public method javax.swing.JMenu.setComponentOrientation() has no spec [v5]
Prasanta Sadhukhan
psadhukhan at openjdk.java.net
Thu Apr 8 04:34:23 UTC 2021
On Thu, 8 Apr 2021 00:37:57 GMT, Sergey Bylokhov <serb at openjdk.org> wrote:
>> The behavior is not a javadoc bug.
>>
>> If a method is overridden with no specified change in behavior, the
>> method will be documented in the "Methods Declared In ..." list at the
>> end of the main summary table.
>>
>> -- Jon
>>
>> On 4/7/21 1:07 PM, Sergey Bylokhov wrote:
>>>
>>> I dont see any update in JDK-8264217. Is this then considered to
>>> be a javadoc bug?
>>>
>>> It does not matter is it a JavaDoc bug or feature. If it is a bug it
>>> will be fixed and spec will be returned for the current method. If it
>>> is an intentional feature to skip the identical comments in the
>>> subclasses then the spec in the current method will be intentionally
>>> skipped.
>>>
>>> —
>>> You are receiving this because you were mentioned.
>>> Reply to this email directly, view it on GitHub
>>> <https://urldefense.com/v3/__https://github.com/openjdk/jdk/pull/3213*issuecomment-815211518__;Iw!!GqivPVa7Brio!Pa32I0dQ97f0ZnfS2GJagqLEL_rDDUn_-KYlfMpVlhPTSTuZMR8dX8JS11YTkpCKIqVxAQ$>,
>>> or unsubscribe
>>> <https://urldefense.com/v3/__https://github.com/notifications/unsubscribe-auth/AOUXBRUWEZO3Y5GPQXJXSDTTHS3ORANCNFSM4Z3HDOJA__;!!GqivPVa7Brio!Pa32I0dQ97f0ZnfS2GJagqLEL_rDDUn_-KYlfMpVlhPTSTuZMR8dX8JS11YTkpAt6XZ-PQ$>.
>>>
>
>> The behavior is not a javadoc bug. If a method is overridden with no specified change in behavior, the method will be documented in the "Methods Declared In ..." list at the end of the main summary table.
>
> If it is not a bug it is necessary to update the javadoc spec:
> https://docs.oracle.com/en/java/javase/16/docs/specs/javadoc/doc-comment-spec.html
> It currently states that in such use-case the spec should be copied, and it also states that "{@inheritDoc}" must force the doc to be copied as well.
>
> Anyway this issue can be closed as not a bug.
I think we should at least use {@inheritDoc} so that if and when javadoc tool is changed, then we would have the possibility of method spec being visible?
In many places, we use {@inheritDoc} [ex. https://github.com/openjdk/jdk/blob/master/src/java.desktop/share/classes/javax/swing/plaf/synth/SynthToolTipUI.java#L68] for same usecase!!!
-------------
PR: https://git.openjdk.java.net/jdk/pull/3213
More information about the swing-dev
mailing list