Skip to content

[doc] ADR 3: Clarify javadoc tags#6392

Merged
adangel merged 1 commit intopmd:mainfrom
adangel:chore/update-adr-3-api
Jan 29, 2026
Merged

[doc] ADR 3: Clarify javadoc tags#6392
adangel merged 1 commit intopmd:mainfrom
adangel:chore/update-adr-3-api

Conversation

@adangel
Copy link
Copy Markdown
Member

@adangel adangel commented Jan 8, 2026

Describe the PR

Add details on how to use javadoc tags for deprecated, experimental and internal APIs.

Related issues

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
Comment thread docs/pages/pmd/projectdocs/decisions/adr-3.md Outdated
@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 15:56:54+00:00 for c90cd52)

@adangel adangel force-pushed the chore/update-adr-3-api branch from 1addf8e to 60e29a4 Compare January 29, 2026 15:40
Add details on how to use javadoc tags for deprecated, experimental
and internal APIs.
@adangel adangel force-pushed the chore/update-adr-3-api branch from 60e29a4 to c90cd52 Compare January 29, 2026 15:41
@adangel adangel merged commit ed0838b into pmd:main Jan 29, 2026
12 checks passed
@adangel adangel deleted the chore/update-adr-3-api 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