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

Add missing links between methods of JavaFX properties

    XMLWordPrintable

    Details

    • Type: Enhancement
    • Status: Resolved
    • Priority: P4
    • Resolution: Fixed
    • Affects Version/s: 18
    • Fix Version/s: 18
    • Component/s: tools
    • Labels:
      None

      Description

      A JavaFX property consists of grouped xxxxProperty(), setXxxx(), and getXxxx() (or isXxxx() for boolean properties) methods. Further, the javadoc support for JavaFX properties creates an entry for the property itself, and summarizes them in a list of properties. For example, here is the entry for the "rotate" property:

      https://openjfx.io/javadoc/16/javafx.graphics/javafx/scene/Node.html#rotateProperty

      In addition to the description, which is copied to the methods for that property, there is a link to the getXxxx() and setXxxx() methods. However, there is no link to the xxxProperty() method. It would be useful to add this link. Similarly, the getXxxx() and setXxxx() methods could link to each other and to xxxxProperty().

      See the following for the current state of the docs:

      https://openjfx.io/javadoc/16/javafx.graphics/javafx/scene/Node.html#rotateProperty()
      https://openjfx.io/javadoc/16/javafx.graphics/javafx/scene/Node.html#setRotate(double)
      https://openjfx.io/javadoc/16/javafx.graphics/javafx/scene/Node.html#getRotate()

      One other bit of missing information that we could consider adding, either as part of this RFE or a separate one, is a `Returns: <descrption>` for the getXxxx() and xxxxProperty() methods, for consistency with the documentation of other non-void methods.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              jjg Jonathan Gibbons
              Reporter:
              kcr Kevin Rushforth
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: