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

[Sergey Bylokhov]

On Thu, 8 Apr 2021 04:27:16 GMT, Prasanta Sadhukhan <psadhukhan 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.
>> 
>> 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!!!

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

All of them are in the SynthXX classes and were added as part of moving that classes to the javax package by the JDK-6827653 in jdk7. The spec of the parent class was used in the CCC since the new functionality of these methods was not specified and was hidden.

So you are right, it looks like the same use case as we discussed here, and if in this case the javadoc was hidden intentionally then I assume it was hidden there as well. Lets wait how the JDK-8264217 will be resolved.

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

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