From 8985c9dbf3b69cfbc59f0c7e1d2e6e3a00bf7a20 Mon Sep 17 00:00:00 2001 From: Andreas Dangel Date: Sat, 14 Jan 2023 10:55:30 +0100 Subject: [PATCH] [doc] Update release notes (#4280) --- docs/pages/release_notes.md | 10 ++++++++++ .../sourceforge/pmd/lang/apex/ast/ApexRootNode.java | 3 +++ 2 files changed, 13 insertions(+) diff --git a/docs/pages/release_notes.md b/docs/pages/release_notes.md index b8f8783555..714579b680 100644 --- a/docs/pages/release_notes.md +++ b/docs/pages/release_notes.md @@ -18,7 +18,17 @@ This is a {{ site.pmd.release_type }} release. ### API Changes +#### Deprecated APIs + +##### For removal + +* {% jdoc !!apex::lang.apex.ast.ApexRootNode#getApexVersion() %} has been deprecated for removal. The version returned is + always `Version.CURRENT`, as the apex compiler integration doesn't use additional information which Apex version + actually is used. Therefore, this method can't be used to determine the Apex version of the project + that is being analyzed. + ### External Contributions +* [#4280](https://github.com/pmd/pmd/pull/4280): \[apex] Deprecate ApexRootNode.getApexVersion - [Aaron Hurst](https://github.com/aaronhurst-google) (@aaronhurst-google) {% endtocmaker %} diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ApexRootNode.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ApexRootNode.java index 3790722c53..ca5a0feece 100644 --- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ApexRootNode.java +++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ApexRootNode.java @@ -46,6 +46,9 @@ public abstract class ApexRootNode extends AbstractApexNo * Use {@link Version} to compare, e.g. * {@code node.getApexVersion() >= Version.V176.getExternal()} * @return the apex version + * @deprecated for removal. The version returned is always Version.CURRENT, as the apex compiler integration + * doesn't use additional information which Apex version actually is used. Therefore, this method can't be + * used to determine the Apex version of the project that is being analyzed. */ @Deprecated public double getApexVersion() {