Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8270996

javadoc: missing comments in serialized classes

    XMLWordPrintable

Details

    • b08

    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.

      Attachments

        Issue Links

          blocks

          Bug - A problem which impairs or prevents the functions of the product. JDK-8325075 Enable -Werror for javadoc to fail on any warnings

          • P4 - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

          Task - A task that needs to be done. JDK-8271083 ☂ Missing documentation in JavaFX API

          • P4 - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

          Task - A task that needs to be done. JDK-8314590 ☂ Eliminate all javadoc warnings in JavaFX

          • P4 - Minor loss of function, or other problem where easy workaround is present.
          • Resolved
          relates to

          Bug - A problem which impairs or prevents the functions of the product. JDK-8325073 javadoc warnings: missing @param tags and other issues

          • P4 - Minor loss of function, or other problem where easy workaround is present.
          • Resolved
          links to

          Commit Commit openjdk/jfx/83012271

          Review Review openjdk/jfx/1386

          Activity

            People

              angorya Andy Goryachev
              kcr Kevin Rushforth
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: