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

hgap and vgap Javadoc should specify units

XMLWordPrintable

    • Icon: Enhancement Enhancement
    • Resolution: Not an Issue
    • Icon: P4 P4
    • tbd
    • 8, 9, 10
    • javafx
    • generic
    • generic

      A DESCRIPTION OF THE REQUEST :
      It appears that GridPane.hGap and vGap units are pixels, but I did not find this anywhere in the Javadocs. The type is double, which also does not lead the developer to conclude the units is pixels. I am not asking for a change in the type (e.g. double). I am asking that the unit be included in the JavaDoc. Many developers will come to JavaFX with prior experience in a different UI framework -- such as WPF/XAML and will wonder what the units are since these frameworks address the same issues.

      JUSTIFICATION :
      For clarity in development

      EXPECTED VERSUS ACTUAL BEHAVIOR :
      EXPECTED -
      The JavaDocs for GridPane hGap and vGap should say the units are pixels (if that is the unit).
      ACTUAL -
      The JavaDoc GridPane getters and setters for hgap and vgap contain useless JavaDoc currently. Currently they don't tell you any more than the method name does.

            arapte Ambarish Rapte
            webbuggrp Webbug Group
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Created:
              Updated:
              Resolved: