Skip to content

[doc] Fix javadoc plugin configuration #5823

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
adangel merged 2 commits into from
Jun 20, 2025
Merged

[doc] Fix javadoc plugin configuration #5823

adangel merged 2 commits into from
Jun 20, 2025
+4 −4

Conversation

@adangel
Copy link
Member

@adangel adangel commented Jun 10, 2025

Describe the PR

Since upgrade to version 3.10.0 the links to pmd-core from other modules didn't work anymore.
Compare https://docs.pmd-code.org/apidocs/pmd-java/7.0.0/net/sourceforge/pmd/lang/java/JavaLanguageModule.html with https://docs.pmd-code.org/apidocs/pmd-java/7.14.0/net/sourceforge/pmd/lang/java/JavaLanguageModule.html

Last working version: 7.8.0

This also fixes the error messages like

[INFO] --- javadoc:3.11.2:jar (attach-javadocs) @ pmd-lua ---
[ERROR] The given File link: /home/andreas/temp/pmd-release-7.14.0/pmd/pmd-lua/../pmd-core/target/apidocs is not a dir.
[ERROR] Error fetching link: /home/andreas/temp/pmd-release-7.14.0/pmd/pmd-lua/../pmd-core/target/apidocs. Ignored it.
[ERROR] The given File link: /home/andreas/temp/pmd-release-7.14.0/pmd/pmd-lua/../pmd-test/target/apidocs is not a dir.
[ERROR] Error fetching link: /home/andreas/temp/pmd-release-7.14.0/pmd/pmd-lua/../pmd-test/target/apidocs. Ignored it.

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.15.0 milestone Jun 10, 2025
@adangel adangel added the in:documentation Affects the documentation [doc] label Jun 10, 2025
@adangel adangel marked this pull request as draft June 10, 2025 19:45
@adangel adangel marked this pull request as ready for review June 10, 2025 19:49
@github-actions
Copy link

github-actions bot commented Jun 10, 2025

Documentation Preview

No regression tested rules have been changed.

(comment created at 2025-06-10 20:06:29+00:00 for 2042e5c)

@adangel adangel merged commit b9bcaa3 into pmd:main Jun 20, 2025
11 checks passed
@adangel adangel deleted the chores/fix-javadoc-offline-links branch June 20, 2025 19:06
adangel added a commit that referenced this pull request Jun 27, 2025
@adangel
[doc] Fix javadoc plugin offline link configuration
48e6c5f 
Refs #5823
Follow-up on 79db238
adangel added a commit to adangel/pmd that referenced this pull request Jul 18, 2025
@adangel
[scala] Fix javadoc config
c8930f4 
Follow-up on pmd#5823
@adangel adangel mentioned this pull request Jul 18, 2025
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

in:documentation Affects the documentation [doc]

Projects

None yet

Milestone

7.15.0

Development

Successfully merging this pull request may close these issues.

1 participant

@adangel