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

[Jonathan Gibbons]

On Thu, 1 Apr 2021 12:45:52 GMT, Kevin Rushforth <kcr at openjdk.org> wrote:

>> I guess openjdk shows file history from 7u23 onwards IIRC so not sure why it is showing "Initial load" and not who/what removed it. Maybe the spec wordings actually was not there but some javadoc trickery was adding the javadoc comment in to the spec document seeing it's overidden from JComponent....
>> I am not sure what needs to be done here...
>
> @prsadhuk You could always add `@inheritDoc` like this:
> 
> /**
>  * {@inheritDoc}
>  */

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 `/** ***@***.***Doc} */`.

"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 supports 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$> 
> 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$>, 
> or unsubscribe 
> <https://urldefense.com/v3/__https://github.com/notifications/unsubscribe-auth/AOUXBRUGHOZZ4X3NOBWRX63TGRS55ANCNFSM4Z3HDOJA__;!!GqivPVa7Brio!Nt46yROIsMrLvPBMvzgGTeSnhOvHtuHlNczVmgAJ-wPR9Lk254rhfVFX79WhAtg5YRT3Kw$>.
>

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

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