Javafx Property Javadocs

When documenting JavaFX observable properties in this repository, add Javadocs only to the property accessor method such as colorProperty().

Rule

For a JavaFX property:

• add Javadocs to the property accessor method, for example colorProperty()
• do not add Javadocs to the getter method such as getColor() or isColor()
• do not add Javadocs to the setter method such as setColor(...)
• do not add Javadocs to the property field declaration itself

Example:

private final StringProperty color = new SimpleStringProperty(this, "color", "");

/**
 * The color property.
 *
 * @return the color property
 */
public final StringProperty colorProperty() {
    return color;
}

public final String getColor() {
    return color.get();
}

public final void setColor(String value) {
    color.set(value);
}

Notes

• Apply this consistently to controls, views, and observable model classes.