From 217f0f43f8d09a44ef25f469d7d77f71b1554422 Mon Sep 17 00:00:00 2001 From: Andreas Dangel Date: Sat, 27 Jan 2024 18:44:01 +0100 Subject: [PATCH] [core] PropertyTypeId and PropertyDescriptor#getTypeId Both stay Internal API, update javadoc Refs #4348 --- .../sourceforge/pmd/properties/PropertyDescriptor.java | 2 ++ .../net/sourceforge/pmd/properties/PropertyTypeId.java | 8 ++++---- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertyDescriptor.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertyDescriptor.java index 5bd40d48fbf..a4e2fc708f9 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertyDescriptor.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertyDescriptor.java @@ -104,6 +104,8 @@ public PropertySerializer serializer() { * Returns the type ID which was used to define this property. Returns * null if this property was defined in Java code and not in XML. This * is used to write the property back to XML, when using a {@link RuleSetWriter}. + * + * @apiNote Internal API */ @InternalApi public @Nullable PropertyTypeId getTypeId() { diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertyTypeId.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertyTypeId.java index 4454f16ee71..972f9204c0c 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertyTypeId.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertyTypeId.java @@ -18,14 +18,14 @@ * of the property that should be built. The mapping between the values of this attribute * and the concrete property that is built is encoded in the constants of this enum. * - *

Properties API changes

This class' API is mainly provided to build GUIs for XPath rules + *

This class' API is mainly provided to build GUIs for XPath rules * like the rule designer, so that they have info about the available properties from XML. As such, - * the number of clients are probably low. Nevertheless, a bunch of members have been deprecated to - * warn about probable upcoming API changes with 7.0.0, but the amount of change may be greater. - * See {@link PropertyDescriptor} for more info about property framework changes with 7.0.0. + * the number of clients are probably low. Fow now, this stays as Internal API and might be + * changed. * * @author Clément Fournier * @since 6.0.0 + * @apiNote Internal API */ @InternalApi public enum PropertyTypeId {