diff --git a/docs/pages/release_notes.md b/docs/pages/release_notes.md index a6d3e00d55..5804572695 100644 --- a/docs/pages/release_notes.md +++ b/docs/pages/release_notes.md @@ -85,6 +85,9 @@ by a corresponding method on `PropertyFactory`: Having a separate property for floats wasn't that useful. * Similarly, {% jdoc props::FloatMultiProperty %} and {% jdoc props::DoubleMultiProperty %} are replaced by {% jdoc !c!:PF#doubleListProperty(java.lang.String) %}. + * {% jdoc props::BooleanProperty %} is replaced by {% jdoc !c!:PF#booleanProperty(java.lang.String) %} + * Its multi-valued counterpart, {% jdoc props::BooleanMultiProperty %}, is not replaced, because it doesn't have a use case. + * {% jdoc props::MethodProperty %}, {% jdoc props::FileProperty %}, {% jdoc props::TypeProperty %} and their multi-valued counterparts are discontinued for lack of a use-case, and have no planned replacement in 7.0.0 for now. diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertyFactory.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertyFactory.java index 004a0cfcd1..9592ce9f07 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertyFactory.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertyFactory.java @@ -180,6 +180,8 @@ public final class PropertyFactory { * @param name Name of the property to build * * @return A new builder + * + * @see #booleanProperty(String, boolean) */ public static GenericPropertyBuilder booleanProperty(String name) { return new GenericPropertyBuilder<>(name, ValueParserConstants.BOOLEAN_PARSER, Boolean.class); @@ -194,6 +196,8 @@ public final class PropertyFactory { * @param defaultValue Default value of the property * * @return A new builder + * + * @see #booleanProperty(String) */ public static GenericPropertyBuilder booleanProperty(String name, boolean defaultValue) { return booleanProperty(name).defaultValue(defaultValue);