RFR: 8324219: Remove incorrect documentation from Animation methods

Michael Strauß mstrauss at openjdk.org
Fri Jan 19 16:14:02 UTC 2024


On Fri, 19 Jan 2024 16:07:31 GMT, Michael Strauß <mstrauss at openjdk.org> wrote:

> The `Animation` class states in the documentation of various methods that the method call would be asynchronous, using language similar to:
> 
> 
> {@code stop()} is an asynchronous call, the {@code Animation} may not stop immediately.
> 
> 
> This is factually wrong, there are no asynchronous calls. In fact, the methods in question can only be called synchronously on the JavaFX Application thread, and the state of the animation is changed immediately. For example, when `stop()` is called, the animation transitions to the stopped state instantly, without waiting for the next animation pulse.

Since this is a documentation-only change, it might also go into jfx22.

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

PR Comment: https://git.openjdk.org/jfx/pull/1342#issuecomment-1900697998


More information about the openjfx-dev mailing list