Skip to content

chore: update javadoc deprecated tags#6389

Merged
adangel merged 1 commit intopmd:mainfrom
adangel:chore/javadoc-deprecated
Jan 29, 2026
Merged

chore: update javadoc deprecated tags#6389
adangel merged 1 commit intopmd:mainfrom
adangel:chore/javadoc-deprecated

Conversation

@adangel
Copy link
Copy Markdown
Member

@adangel adangel commented Jan 8, 2026

Describe the PR

This PR updates the deprecated tags to always contain the version, since the element has been deprecated. This makes it easy to see, when something has been deprecated.

For now, this is not consistently applied. For future, we need to manually ensure this.
Essentially, this PR proposes this format:

/**
 * @deprecated Since x.y.z. Description.
 */
@Deprecated
...

Btw. javadoc creates an overview: https://docs.pmd-code.org/apidocs/pmd-core/latest/deprecated-list.html

It also fixes the missing deprecated info for package net.sourceforge.pmd.lang.symboltable

Related issues

  • Fix #

Ready?

  • Added unit tests for fixed bug/feature
  • Passing all unit tests
  • Complete build ./mvnw clean verify passes (checked automatically by github actions)
  • Added (in-code) documentation (if needed)

@adangel adangel added this to the 7.21.0 milestone Jan 8, 2026
@adangel adangel added the in:documentation Affects the documentation [doc] label Jan 8, 2026
@pmd-actions-helper
Copy link
Copy Markdown
Contributor

pmd-actions-helper Bot commented Jan 8, 2026

Documentation Preview

Compared to main:
This changeset changes 0 violations,
introduces 0 new violations, 0 new errors and 0 new configuration errors,
removes 0 violations, 0 errors and 0 configuration errors.

Regression Tester Report

(comment created at 2026-01-29 16:08:54+00:00 for e7d9729)

@adangel adangel mentioned this pull request Jan 8, 2026
4 tasks
All deprecated infos should contain the version, since the
element has been deprecated.
@adangel adangel force-pushed the chore/javadoc-deprecated branch from 1f0ca31 to e7d9729 Compare January 29, 2026 15:52
@adangel adangel merged commit c4c1edb into pmd:main Jan 29, 2026
12 checks passed
@adangel adangel deleted the chore/javadoc-deprecated branch January 29, 2026 16:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

in:documentation Affects the documentation [doc]

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant