<Swing Dev> RFR: 8264218: Public method javax.swing.JMenu.setComponentOrientation() has no spec

[Sergey Bylokhov]

On Thu, 1 Apr 2021 15:29:34 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

>>> 
>>> Starting in JDK 10, the default behavior of the standard doclet was changed so that if a method is just being overridden for implementation reasons, and there is no change in the public spec or signature, then the method will not be listed in the main part of the summary table and corresponding details section.  Instead, it will just be listed along with other inherited methods at the end of the summary section, in a list which is renamed from "Methods inherited from ..." to "Methods declared in ..." To be clear, this behavior only applies when there is nothing new to document about the overriding method. "No change in spec" means either no doc comment or a comment that is just `/** {@inheritdoc} */` or its whitespace equivalent. "No change in signature" covers publicly visibly changes like covariant return, change in modifiers, change in throws list, etc. You can change the behavior on a per-instance behavior by providing additional changes in the doc comment. javadoc still supp
 orts the old style of doc generation with a command-line option, but for JDK docs, the default is the new behavior I described.
>>> […](#)
>>> -- Jon
>>> On 4/1/21 5:43 AM, Kevin Rushforth wrote: The |javadoc| tool (or the standard doclet) used to automatically copy the description from the superclass, and it seems that it no longer does. Perhaps @jonathan-gibbons <[https://urldefense.com/v3/__https://github.com/jonathan-gibbons__;!!GqivPVa7Brio!Nt46yROIsMrLvPBMvzgGTeSnhOvHtuHlNczVmgAJ-wPR9Lk254rhfVFX79WhAtjxN8g4zw$](https://urldefense.com/v3/__https://github.com/jonathan-gibbons__;!!GqivPVa7Brio!Nt46yROIsMrLvPBMvzgGTeSnhOvHtuHlNczVmgAJ-wPR9Lk254rhfVFX79WhAtjxN8g4zw%24)> could comment on this change? — 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-811880830__;Iw!!GqivPVa7Brio!Nt46yROIsMrLvPBMvzgGTeSnhOvHtuHlNczVmgAJ-wPR9Lk254rhfVFX79WhAtiQlz8B-g$](https://urldefense.com/v3/__https://github.com/openjdk/jdk/pull/3213*issuecomment-811880830__;Iw!!GqivPVa7Brio!Nt46yROIsMrLvPBMvzgGTeSnhOvHtuHlNczVmg
 AJ-wPR9Lk254rhfVFX79WhAtiQlz8B-g%24)>, or unsubscribe <[https://urldefense.com/v3/__https://github.com/notifications/unsubscribe-auth/AOUXBRUGHOZZ4X3NOBWRX63TGRS55ANCNFSM4Z3HDOJA__;!!GqivPVa7Brio!Nt46yROIsMrLvPBMvzgGTeSnhOvHtuHlNczVmgAJ-wPR9Lk254rhfVFX79WhAtg5YRT3Kw$](https://urldefense.com/v3/__https://github.com/notifications/unsubscribe-auth/AOUXBRUGHOZZ4X3NOBWRX63TGRS55ANCNFSM4Z3HDOJA__;!!GqivPVa7Brio!Nt46yROIsMrLvPBMvzgGTeSnhOvHtuHlNczVmgAJ-wPR9Lk254rhfVFX79WhAtg5YRT3Kw%24)>.
>> 
>> So, are you saying that even if we provide @inheritDoc, it will not be listed if there is no change in spec compared to super class?
>
> On 4/1/21 8:26 AM, Prasanta Sadhukhan wrote:
>>
>> So, are you saying that even if we provide @inheritdoc 
>> <https://urldefense.com/v3/__https://github.com/inheritdoc__;!!GqivPVa7Brio!OR4b9howuG4BpVugrQEdNUuVqpxPta_Ff7BnXWbd-LDSRQ9jjAQ4mdGVtd097q0D29aUBA$>, 
>> it will not be listed if there is no change in spec compared to super 
>> class?
>>
> 
> Yes.

The method was overridden to change the implementation without changing of specification. This is exactly the case that was changed in the JavaDoc tool in jdk10. For this case, the JavaDoc tool decided to skip spec generation, it is a feature.
So this is not a bug in the Swing, probably it is a bug in the JavaDoc tool, maybe not a bug at all.

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

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