JDK-8270996 : javadoc: missing comments in serialized classes
  • Type: Bug
  • Component: javafx
  • Sub-Component: other
  • Affected Version: jfx11,jfx17
  • Priority: P4
  • Status: Resolved
  • Resolution: Fixed
  • Submitted: 2021-07-20
  • Updated: 2024-03-15
  • Resolved: 2024-03-05
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.
Other
jfx23 b08Fixed
Related Reports
Blocks :  
JDK-8325075 - Enable -Werror for javadoc to fail on any warnings
Blocks :  
JDK-8314590 - ☂ Eliminate all javadoc warnings in JavaFX
Blocks :  
JDK-8271083 - ☂ Missing documentation in JavaFX API
Relates :  
JDK-8325073 - javadoc warnings: missing @param tags and other issues
Description
Most JavaFX classes are not serializable. However, we have a few that are, including:

* JFXPanel (since it inherits from javax.swing.JCompoent)
* Event (since it inherits from java.util.EventObject)

At the very least, the JFXPanel class should have the same disclaimer as its superclass. Namely:

"The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing."

For Event we either need to suppress the warning or document the private fields.

We might split this into two bugs depending on how we address serialization of events.
Comments
Changeset: 83012271 Author: Andy Goryachev <angorya@openjdk.org> Date: 2024-03-05 15:37:36 +0000 URL: https://git.openjdk.org/jfx/commit/830122718d49c8c27a2ee3f44fdf34529f873753
05-03-2024
A pull request was submitted for review. URL: https://git.openjdk.org/jfx/pull/1386 Date: 2024-02-29 16:53:26 +0000
29-02-2024
As of today, early in the JavaFX 23 development phase, the attached list of 91 warnings is still accurate.
31-01-2024
I filed JDK-8271083 as an umbrella bug to track all errors where there are missing javadoc comments, including this issue and similar mistakes in other parts of the API. See the description of that bug for more information.
21-07-2021