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

BorderStroke documentation typos and issues

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Duplicate
    • Icon: P4 P4
    • None
    • 8, 9
    • javafx

      The following was reported to the javasedocs_us@oracle.com alias:

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

      Hello,

      On page

      http://docs.oracle.com/javase/8/javafx/api/javafx/scene/layout/BorderStroke.html:

      1) The documentation for the long-form constructor, which takes 11 arguments, contains the statement

      "bottomStroke - The fill to use on the bottom. If null, defaults to the same value as bottomStroke"

      I think this should be "... value as topStroke", as given in the "Method Detail" section for getBottomStroke().

      2) The description of argument "insets" for the same constructor does not give a "If null, we default ..." statement like the descriptions of the other arguments, though the "Method Detail" section for getInsets() does specify "EMPTY", which should probably be expanded to "Insets.EMPTY".

      Same for the 5 argument constructor.

      3) The detail for method getTopStyle() gives a default of "none". Maybe this should be "BorderStrokeStyle.NONE".

      4) The detail for method getTopStroke() gives a default of "black". Maybe this should be "Color.BLACK".

      5) There are several getSomething() methods which list a default of "null = somethingElse". This could be understood to mean that null is a possible return value that is interpreted to mean "somethingElse", but the source code seems to be written so that null is not a possible return value.

            nlisker Nir Lisker
            kcr Kevin Rushforth
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: