RFR: 8324219: Remove incorrect documentation from Animation methods

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


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.

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

Commit messages:
 - Remove incorrect documentation for several Animation methods

Changes: https://git.openjdk.org/jfx/pull/1342/files
 Webrev: https://webrevs.openjdk.org/?repo=jfx&pr=1342&range=00
  Issue: https://bugs.openjdk.org/browse/JDK-8324219
  Stats: 29 lines in 1 file changed: 4 ins; 15 del; 10 mod
  Patch: https://git.openjdk.org/jfx/pull/1342.diff
  Fetch: git fetch https://git.openjdk.org/jfx.git pull/1342/head:pull/1342

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


More information about the openjfx-dev mailing list