On Thu, 11 Aug 2022 23:11:45 GMT, Kevin Rushforth <[email protected]> wrote:

>> Andy Goryachev has updated the pull request with a new target base due to a 
>> merge or a rebase. The incremental webrev excludes the unrelated changes 
>> brought in by the merge/rebase. The pull request contains 13 additional 
>> commits since the last revision:
>> 
>>  - 8290844: review comments
>>  - Merge remote-tracking branch 'origin/master' into 8290844.skin.install
>>  - 8290844: javadoc
>>  - Merge remote-tracking branch 'origin/master' into 8290844.skin.install
>>  - 8289397: added space
>>  - 8290844: skin.install
>>  - 8290844: whitespace
>>  - 8290844: validate input
>>  - 8290844: illegal argument exception
>>  - 8290844: illegal argument exception
>>  - ... and 3 more: https://git.openjdk.org/jfx/compare/98cafacd...647ecd6c
>
> modules/javafx.controls/src/main/java/javafx/scene/control/Skinnable.java 
> line 64:
> 
>> 62:      * @throws IllegalArgumentException if {@code Skin} does not 
>> correspond to this {@code Skinnable}
>> 63:      */
>> 64:     public void setSkin(Skin<?> value);
> 
> Generally docs for properties should go on just the property and not the 
> setter or getter. The docs will be copied and cross linked by the javadoc 
> tool. Can you try that, and generate a javadoc, and see if that holds in this 
> case (we don't have many cases where a property is in an interface).

So javadoc tool ignores the interface, resulting in Control.setSkin(skin) 
method inheriting the property's description.  

Curiously, eclipse does show the interface's version, which I think helps more 
than having three identical descriptions for the property, its getter and 
setter.

What would you recommend we do here?

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

PR: https://git.openjdk.org/jfx/pull/845

Reply via email to