[jfx15] RFR: 8228570: Add various documentation clarifications [v2]

Kevin Rushforth kcr at openjdk.java.net
Mon Aug 10 13:10:07 UTC 2020


On Mon, 10 Aug 2020 06:34:57 GMT, Nir Lisker <nlisker at openjdk.org> wrote:

>> modules/javafx.graphics/src/main/java/javafx/scene/Node.java line 868:
>> 
>>> 867:      * clearing the map or overriding its values. These entries are not removed automatically if the node is
>>> removed from the layout 868:      * manager, so unused entries can exist throughout the life of the node.
>>> 869:      *
>> 
>> If we were in the habit of using `@apiNote` then that's probably where the note about layout managers using the node
>> properties would go. Since we aren't, this seems fine.
>
> I think that `@aipNote` is indeed better. Does it require a CSR?

In this case, I think it would be fine without a CSR, since it is just a clarifying note for developers.

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

PR: https://git.openjdk.java.net/jfx/pull/276


More information about the openjfx-dev mailing list