chore: update javadoc deprecated tags

adangel · adangel · commit e7d97290ca93 · 2026-01-29T16:52:26.000+01:00
All deprecated infos should contain the version, since the
element has been deprecated.
diff --git a/pmd-ant/src/main/java/net/sourceforge/pmd/ant/CPDTask.java b/pmd-ant/src/main/java/net/sourceforge/pmd/ant/CPDTask.java
@@ -67,6 +67,9 @@ public class CPDTask extends Task {
 
     private static final String TEXT_FORMAT = "text";
     private static final String XML_FORMAT = "xml";
+    /**
+     * @deprecated Since 7.3.0.
+     */
     @Deprecated
     private static final String XMLOLD_FORMAT = "xmlold";
     private static final String CSV_FORMAT = "csv";
@@ -78,6 +81,9 @@ public class CPDTask extends Task {
     private boolean ignoreIdentifiers;
     private boolean ignoreAnnotations;
     private boolean ignoreUsings;
+    /**
+     * @deprecated Since 7.3.0.
+     */
     @Deprecated
     private boolean skipLexicalErrors;
     private boolean skipDuplicateFiles;
@@ -241,7 +247,7 @@ public void setIgnoreUsings(boolean value) {
     }
 
     /**
-     * @deprecated Use {@link #setFailOnError(boolean)} instead.
+     * @deprecated Since 7.3.0. Use {@link #setFailOnError(boolean)} instead.
      */
     @Deprecated
     public void setSkipLexicalErrors(boolean skipLexicalErrors) {
diff --git a/pmd-cli/src/main/java/net/sourceforge/pmd/cli/commands/internal/AbstractAnalysisPmdSubcommand.java b/pmd-cli/src/main/java/net/sourceforge/pmd/cli/commands/internal/AbstractAnalysisPmdSubcommand.java
@@ -55,6 +55,9 @@ protected static class FileCollectionOptions<C extends AbstractConfiguration> {
 
         boolean usesDeprecatedIgnoreListOption = false;
 
+        /**
+         * @deprecated Since 7.14.0. Use {@code --exclude-file-list} instead.
+         */
         @Option(names = "--ignore-list",
                 description = "(DEPRECATED: use --exclude-file-list) Path to a file containing a list of files to exclude from the analysis, one path per line. "
                               + "This option can be combined with --dir, --file-list and --uri.")
diff --git a/pmd-cli/src/main/java/net/sourceforge/pmd/cli/commands/internal/CpdCommand.java b/pmd-cli/src/main/java/net/sourceforge/pmd/cli/commands/internal/CpdCommand.java
@@ -74,7 +74,7 @@ public class CpdCommand extends AbstractAnalysisPmdSubcommand<CPDConfiguration>
     private boolean ignoreIdentifierAndLiteralSequences;
 
     /**
-     * @deprecated Since 7.3.0. Use --[no-]fail-on-error instead.
+     * @deprecated Since 7.3.0. Use {@code --[no-]fail-on-error} instead.
      */
     @Option(names = "--skip-lexical-errors",
             description = "Skip files which can't be tokenized due to invalid characters, instead of aborting with an error. Deprecated - use --[no-]fail-on-error instead.")
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/CPDConfiguration.java b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/CPDConfiguration.java
@@ -67,6 +67,9 @@ public class CPDConfiguration extends AbstractConfiguration {
 
     private boolean ignoreIdentifierAndLiteralSequences = false;
 
+    /**
+     * @deprecated Since 7.3.0.
+     */
     @Deprecated
     // Note: The default value was false until up to 7.3.0 and is true since 7.4.0
     private boolean skipLexicalErrors = true;
@@ -231,7 +234,7 @@ public void setIgnoreIdentifierAndLiteralSequences(boolean ignoreIdentifierAndLi
     }
 
     /**
-     * @deprecated This option will be removed. With {@link #isFailOnError()}, you can
+     * @deprecated Since 7.3.0. This option will be removed. With {@link #isFailOnError()}, you can
      * control whether lexical errors should fail the build or not.
      */
     @Deprecated
@@ -240,7 +243,7 @@ public boolean isSkipLexicalErrors() {
     }
 
     /**
-     * @deprecated This option will be removed. With {@link #setFailOnError(boolean)}, you can
+     * @deprecated Since 7.3.0. This option will be removed. With {@link #setFailOnError(boolean)}, you can
      * control whether lexical errors should fail the build or not.
      */
     @Deprecated
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/XMLOldRenderer.java b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/XMLOldRenderer.java
@@ -13,7 +13,7 @@
  *
  * <p>This renderer is available as "xmlold".
  *
- * @deprecated Update your tools to use the standard XML renderer "xml" again.
+ * @deprecated Since 7.3.0. Update your tools to use the standard XML renderer "xml" again.
  */
 @Deprecated
 public class XMLOldRenderer implements CPDReportRenderer {
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/impl/antlr4/AntlrToken.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/impl/antlr4/AntlrToken.java
@@ -34,7 +34,7 @@ public class AntlrToken implements GenericToken<AntlrToken> {
      * @param previousComment The previous comment
      * @param textDoc         The text document
      *
-     * @deprecated Don't create antlr tokens directly, use an {@link AntlrTokenManager}
+     * @deprecated Since 7.3.0. Don't create antlr tokens directly, use an {@link AntlrTokenManager}
      */
     @Deprecated
     public AntlrToken(final Token token, final AntlrToken previousComment, TextDocument textDoc) {
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/impl/javacc/AbstractTokenManager.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/impl/javacc/AbstractTokenManager.java
@@ -33,7 +33,7 @@ public void setSuppressMarker(String marker) {
     }
 
     /**
-     * @deprecated since 7.14.0. Use {@link #getSuppressionComments()} instead.
+     * @deprecated Since 7.14.0. Use {@link #getSuppressionComments()} instead.
      */
     @Deprecated
     public Map<Integer, String> getSuppressMap() {
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/symboltable/package-info.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/symboltable/package-info.java
@@ -3,10 +3,15 @@
  */
 
 /**
- * @deprecated Since 7.19.0. All classes in this package are deprecated. The symbol table and type
+ * <strong>Deprecated: Since 7.19.0.</strong><br>
+ * <em>
+ * All classes in this package are deprecated. The symbol table and type
  * resolution implementation for Java has been rewritten from scratch for PMD 7.0.0. This package
  * is the remains of the old symbol table API, that is only used by PL/SQL. For PMD 8.0.0 all these
  * classes will be removed from pmd-core.
+ * </em>
+ *
+ * @deprecated Since 7.19.0.
  */
 @Deprecated
 package net.sourceforge.pmd.lang.symboltable;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/CSVWriter.java b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/CSVWriter.java
@@ -9,14 +9,17 @@
 import java.util.Iterator;
 import java.util.List;
 
+import net.sourceforge.pmd.annotation.InternalApi;
+
 /**
  * A generic writer that formats input items into rows and columns per the
  * provided column descriptors.
  *
  * @author Brian Remedios
  * @param <T>
- * @deprecated This is internal API and an implementation detail for {@link CSVRenderer}.
+ * @apiNote This is internal API and an implementation detail for {@link CSVRenderer}.
  */
+@InternalApi
 class CSVWriter<T> {
 
     private final String separator; // e.g., the comma
diff --git a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/ASTClassDeclaration.java b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/ASTClassDeclaration.java
@@ -60,7 +60,7 @@ void setInterface() {
 
 
     /**
-     * @deprecated Use {@link #getPermitsClause()} or {@link JClassSymbol#getPermittedSubtypes()}
+     * @deprecated Since 7.8.0. Use {@link #getPermitsClause()} or {@link JClassSymbol#getPermittedSubtypes()}
      */
     @Deprecated
     public List<ASTClassType> getPermittedSubclasses() {
diff --git a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/ASTFieldDeclaration.java b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/ASTFieldDeclaration.java
@@ -51,7 +51,7 @@ protected <P, R> R acceptVisitor(JavaVisitor<? super P, ? extends R> visitor, P
      *
      * @return a String representing the name of the variable
      *
-     * @deprecated FieldDeclaration may declare several variables, so this is not exhaustive
+     * @deprecated Since 6.10.0. FieldDeclaration may declare several variables, so this is not exhaustive
      *     Iterate on the {@linkplain ASTVariableId VariableIds} instead
      */
     @Deprecated
diff --git a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/ASTLambdaExpression.java b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/ASTLambdaExpression.java
@@ -86,7 +86,7 @@ public boolean isExpressionBody() {
     /**
      * Returns the body of this expression, if it is a block.
      *
-     * @deprecated Use {@link #getBlockBody()}
+     * @deprecated Since 7.1.0. Use {@link #getBlockBody()}
      */
     @Deprecated
     public @Nullable ASTBlock getBlock() {
@@ -96,7 +96,7 @@ public boolean isExpressionBody() {
     /**
      * Returns the body of this expression, if it is an expression.
      *
-     * @deprecated Use {@link #getExpressionBody()}
+     * @deprecated Since 7.1.0. Use {@link #getExpressionBody()}
      */
     @Deprecated
     public @Nullable ASTExpression getExpression() {
diff --git a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/ASTRecordPattern.java b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/ASTRecordPattern.java
@@ -49,7 +49,7 @@ public ASTPatternList getComponentPatterns() {
     /**
      * Returns the declared variable.
      *
-     * @deprecated This method was added here by mistake. Record patterns don't declare a pattern variable
+     * @deprecated Since 7.3.0. This method was added here by mistake. Record patterns don't declare a pattern variable
      * for the whole pattern, but rather for individual record components, which can be accessed via
      * {@link #getComponentPatterns()}.
      */
diff --git a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/SyntacticJavaTokenizerFactory.java b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/SyntacticJavaTokenizerFactory.java
@@ -19,14 +19,17 @@
  * Creates a tokenizer, that uses the syntactic grammar to provide context
  * for the tokenizer when reducing the input characters to tokens.
  *
- * @deprecated This implementation has been superseded. It is not necessary to parse Java code in order to tokenize it.
+ * @deprecated Since 7.2.0. This implementation has been superseded. It is not necessary to parse Java code in order to tokenize it.
  */
 @Deprecated
 public final class SyntacticJavaTokenizerFactory {
     private SyntacticJavaTokenizerFactory() {
         // factory class
     }
 
+    /**
+     * @deprecated Since 7.2.0. This implementation has been superseded. It is not necessary to parse Java code in order to tokenize it.
+     */
     @Deprecated
     public static TokenManager<JavaccToken> createTokenizer(CharStream cs) {
         final List<JavaccToken> tokenList = new ArrayList<>();
diff --git a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/bestpractices/JUnitAssertionsShouldIncludeMessageRule.java b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/bestpractices/JUnitAssertionsShouldIncludeMessageRule.java
@@ -5,7 +5,7 @@
 package net.sourceforge.pmd.lang.java.rule.bestpractices;
 
 /**
- * @deprecated The rule was renamed {@link UnitTestAssertionsShouldIncludeMessageRule}
+ * @deprecated Since 7.7.0. The rule was renamed {@link UnitTestAssertionsShouldIncludeMessageRule}
  */
 @Deprecated
 public class JUnitAssertionsShouldIncludeMessageRule extends UnitTestAssertionsShouldIncludeMessageRule {
diff --git a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/bestpractices/JUnitTestContainsTooManyAssertsRule.java b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/bestpractices/JUnitTestContainsTooManyAssertsRule.java
@@ -5,7 +5,7 @@
 package net.sourceforge.pmd.lang.java.rule.bestpractices;
 
 /**
- * @deprecated The rule was renamed {@link UnitTestContainsTooManyAssertsRule}
+ * @deprecated Since 7.7.0. The rule was renamed {@link UnitTestContainsTooManyAssertsRule}
  */
 @Deprecated
 public class JUnitTestContainsTooManyAssertsRule extends UnitTestContainsTooManyAssertsRule {
diff --git a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/bestpractices/JUnitTestsShouldIncludeAssertRule.java b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/bestpractices/JUnitTestsShouldIncludeAssertRule.java
@@ -5,7 +5,7 @@
 package net.sourceforge.pmd.lang.java.rule.bestpractices;
 
 /**
- * @deprecated The rule was renamed {@link UnitTestShouldIncludeAssertRule}
+ * @deprecated Since 7.7.0. The rule was renamed {@link UnitTestShouldIncludeAssertRule}
  */
 @Deprecated
 public class JUnitTestsShouldIncludeAssertRule extends UnitTestShouldIncludeAssertRule {
diff --git a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/design/ExcessiveImportsRule.java b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/design/ExcessiveImportsRule.java
@@ -29,7 +29,7 @@ protected int defaultReportLevel() {
     }
 
     /**
-     * @deprecated since 7.18.0. This method is not used anymore and shouldn't be implemented.
+     * @deprecated Since 7.18.0. This method is not used anymore and shouldn't be implemented.
      */
     @Deprecated
     protected boolean isViolation(ASTCompilationUnit node, int reportLevel) {
diff --git a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/design/ExcessiveParameterListRule.java b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/design/ExcessiveParameterListRule.java
@@ -38,7 +38,7 @@ private boolean areParametersOfPrivateConstructor(ASTFormalParameters params) {
     }
 
     /**
-     * @deprecated since 7.18.0. This method is not used anymore and shouldn't be implemented.
+     * @deprecated Since 7.18.0. This method is not used anymore and shouldn't be implemented.
      */
     @Deprecated
     protected boolean isViolation(ASTFormalParameters node, int reportLevel) {
diff --git a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/design/ExcessivePublicCountRule.java b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/design/ExcessivePublicCountRule.java
@@ -40,7 +40,7 @@ protected int defaultReportLevel() {
     }
 
     /**
-     * @deprecated since 7.18.0. This method is not used anymore and shouldn't be implemented.
+     * @deprecated Since 7.18.0. This method is not used anymore and shouldn't be implemented.
      */
     @Deprecated
     protected boolean isViolation(ASTTypeDeclaration node, int reportLevel) {
diff --git a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/design/SingularFieldRule.java b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/design/SingularFieldRule.java
@@ -98,9 +98,9 @@ public Object visitJavaNode(JavaNode node, Object data) {
     /**
      * This method is only relevant for this rule. It will be removed in the future.
      *
-     * @deprecated This method will be removed. Don't use it.
+     * @deprecated Since 7.1.0. This method will be removed. Don't use it.
      */
-    @Deprecated //(since = "7.1.0", forRemoval = true)
+    @Deprecated
     public static boolean mayBeSingular(ModifierOwner varId) {
         return isPrivateNotFinal(varId);
     }
diff --git a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/types/TypeOps.java b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/types/TypeOps.java
@@ -407,6 +407,9 @@ public static Convertibility isConvertible(@NonNull JTypeMirror t, @NonNull JTyp
         return SubtypeVisitor.INFERENCE.isConvertible(t, s, true);
     }
 
+    /**
+     * @deprecated Since 7.2.0. Use {@link #isConvertible(JTypeMirror, JTypeMirror)} or {@link #isConvertibleNoCapture(JTypeMirror, JTypeMirror)} instead.
+     */
     @Deprecated // unused
     public static Convertibility isConvertible(@NonNull JTypeMirror t, @NonNull JTypeMirror s, boolean capture) {
         return SubtypeVisitor.PURE.isConvertible(t, s, capture);
diff --git a/pmd-lang-test/src/main/kotlin/net/sourceforge/pmd/lang/test/ast/BaseParsingHelper.kt b/pmd-lang-test/src/main/kotlin/net/sourceforge/pmd/lang/test/ast/BaseParsingHelper.kt
@@ -47,6 +47,9 @@ abstract class BaseParsingHelper<Self : BaseParsingHelper<Self, T>, T : RootNode
         val configLanguageProperties: LanguagePropertyBundle.() -> Unit = {}
     ) {
 
+        /**
+         * @deprecated Since 7.12.0. Overload added for binary compatibility.
+         */
         @Deprecated("Overload added for binary compatibility")
         constructor(
             doProcess: Boolean,
@@ -64,6 +67,9 @@ abstract class BaseParsingHelper<Self : BaseParsingHelper<Self, T>, T : RootNode
             suppressMarker,
             configLanguageProperties = {})
 
+        /**
+         * @deprecated Since 7.12.0. Overload added for binary compatibility.
+         */
         @Deprecated("Overload added for binary compatibility")
         fun copy(
             doProcess: Boolean,
diff --git a/pmd-lang-test/src/main/kotlin/net/sourceforge/pmd/lang/test/ast/IntelliMarker.kt b/pmd-lang-test/src/main/kotlin/net/sourceforge/pmd/lang/test/ast/IntelliMarker.kt
@@ -14,6 +14,9 @@ import org.junit.jupiter.api.Test
  * Kotest, but was removed in 4.2.0 without explanation.
  */
 interface IntelliMarker {
+    /**
+     * @deprecated Since 7.16.0. This is not an API.
+     */
     @Deprecated("This is not an API")
     fun primer() {
     }

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`*`
`14`	`14`	`* <p>This renderer is available as "xmlold".`
`15`	`15`	`*`
`16`		`- * @deprecated Update your tools to use the standard XML renderer "xml" again.`
	`16`	`+ * @deprecated Since 7.3.0. Update your tools to use the standard XML renderer "xml" again.`
`17`	`17`	`*/`
`18`	`18`	`@Deprecated`
`19`	`19`	`public class XMLOldRenderer implements CPDReportRenderer {`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public class AntlrToken implements GenericToken<AntlrToken> {`
`34`	`34`	`* @param previousComment The previous comment`
`35`	`35`	`* @param textDoc The text document`
`36`	`36`	`*`
`37`		`- * @deprecated Don't create antlr tokens directly, use an {@link AntlrTokenManager}`
	`37`	`+ * @deprecated Since 7.3.0. Don't create antlr tokens directly, use an {@link AntlrTokenManager}`
`38`	`38`	`*/`
`39`	`39`	`@Deprecated`
`40`	`40`	`public AntlrToken(final Token token, final AntlrToken previousComment, TextDocument textDoc) {`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ public void setSuppressMarker(String marker) {`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`/**`
`36`		`- * @deprecated since 7.14.0. Use {@link #getSuppressionComments()} instead.`
	`36`	`+ * @deprecated Since 7.14.0. Use {@link #getSuppressionComments()} instead.`
`37`	`37`	`*/`
`38`	`38`	`@Deprecated`
`39`	`39`	`public Map<Integer, String> getSuppressMap() {`