Skip to content

JavadocLinkGenerator.createLink(String) must consider module names - #1039

Merged
kwin merged 1 commit into
masterfrom
bugfix/javadoc-url-for-package-and-classname-with-modules
Dec 23, 2025
Merged

kwin merged 1 commit into
masterfrom
bugfix/javadoc-url-for-package-and-classname-with-modules

Conversation

@kwin

@kwin kwin commented Dec 15, 2025

Copy link
Copy Markdown
Member

When link towards external javadoc with modules generated include the module name in the URL path

This closes #1038

Following this checklist to help us incorporate your
contribution quickly and easily:

  • Your pull request should address just one issue, without pulling in other changes.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Each commit in the pull request should have a meaningful subject line and body.
    Note that commits might be squashed by a maintainer on merge.
  • Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied.
    This may not always be possible but is a best-practice.
  • Run mvn verify to make sure basic checks pass.
    A more thorough check will be performed on your pull request automatically.
  • You have run the integration tests successfully (mvn -Prun-its verify).

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

@kwin

kwin commented Dec 15, 2025 •

Copy link
Copy Markdown
Member Author

Module specific internal javadoc tracked separately in #1040. This requires some more effort and is right now pretty much an edge case.

@kwin
kwin force-pushed the bugfix/javadoc-url-for-package-and-classname-with-modules branch from ea37e1c to ee26944 Compare December 16, 2025 08:03
@kwin
kwin marked this pull request as ready for review December 16, 2025 08:03
When link towards external javadoc with modules generated include the
module name in the URL path

This closes #1038
@kwin
kwin force-pushed the bugfix/javadoc-url-for-package-and-classname-with-modules branch from ee26944 to 4541bd0 Compare December 23, 2025 10:48
@michael-o
michael-o removed their request for review December 23, 2025 10:52
@kwin kwin added the bug Something isn't working label Dec 23, 2025
@kwin kwin self-assigned this Dec 23, 2025
@kwin
kwin merged commit 1cec1e1 into master Dec 23, 2025
42 of 53 checks passed
@kwin
kwin deleted the bugfix/javadoc-url-for-package-and-classname-with-modules branch December 23, 2025 13:36
@github-actions github-actions Bot added this to the 4.0.0-beta-3 milestone Dec 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

JavadocLinkGenerator.createLink(String) generates incorrect external links for Javadocs being generated with module names

2 participants