Skip to content

JavadocHelper: Support Automatic-Module-Name for Javadoc URL lookup#9528

Open
NicolaIsotta wants to merge 1 commit into
apache:masterfrom
NicolaIsotta:amn-javadoc
Open

JavadocHelper: Support Automatic-Module-Name for Javadoc URL lookup#9528
NicolaIsotta wants to merge 1 commit into
apache:masterfrom
NicolaIsotta:amn-javadoc

Conversation

@NicolaIsotta

Copy link
Copy Markdown
Contributor

When resolving module-prefixed Javadoc URLs for libraries lacking a module-info.class, JavadocHelper now checks also the jar manifest for Automatic-Module-Name. This allows automatic modules without an explicit module-info.class to correctly resolve module-prefixed Javadoc paths.


^Add meaningful description above

Click to collapse/expand PR instructions

By opening a pull request you confirm that, unless explicitly stated otherwise, the changes -

  • are all your own work, and you have the right to contribute them.
  • are contributed solely under the terms and conditions of the Apache License 2.0 (see section 5 of the license for more information).

LLMs, Commit messages and PR description:

  • Please make sure (eg. git log) that all commits have a valid name and email address for you in the Author field.
  • LLM assisted commits should be attributed with an Assisted-by: MODEL_NAME MODEL_VERSION line appended to the commit message.
    • Please mention coding assistance in the PR description too (eg. by adding the same Assisted-by line from above)
    • Please describe the changes in your own words - we'd like to know you understand the changes being made!

If you're a first time contributor, see the Contributing guidelines for more information.

If you're a committer, please label the PR before pressing "Create pull request" so that the right test jobs can run.

PR approval and merge checklist:

  1. Was this PR correctly labeled, did the right tests run? When did they run?
  2. Is this PR squashed?
  3. Are author name / email address correct? Are co-authors correctly listed? Do the commit messages need updates?
  4. Does the PR title and description still fit after the Nth iteration? Is the description sufficient to appear in the release notes?

If this PR targets the delivery branch: don't merge. (full wiki article)

When resolving module-prefixed Javadoc URLs for libraries lacking a `module-info.class`,
JavadocHelper now checks also the jar manifest for `Automatic-Module-Name`.
This allows automatic modules without an explicit `module-info.class` to correctly resolve module-prefixed Javadoc paths.
@NicolaIsotta

Copy link
Copy Markdown
Contributor Author

To test:

  • create a java maven project
  • add omnifaces 4.7.10 as a dependency
  • from the project tab, expand the "Dependecies" node
  • Right click the omnifaces node and click "Download Javadoc"
  • Open the node, open a package and right click a .class file
  • Choose "Show Javadoc" from the context menu

On NB30 a toast notification will appear, stating the no javadoc was found.
With the PR applied, the javadoc should be opened correctly

@mbien mbien added Java [ci] enable extra Java tests (java.completion, java.source.base, java.hints, refactoring.java, form) JavaDoc [ci] enable java/javadoc tests and build-javadoc target ci:dev-build [ci] produce a dev-build zip artifact (7 days expiration, see link on workflow summary page) labels Jul 21, 2026
@apache apache locked and limited conversation to collaborators Jul 21, 2026
@apache apache unlocked this conversation Jul 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:dev-build [ci] produce a dev-build zip artifact (7 days expiration, see link on workflow summary page) Java [ci] enable extra Java tests (java.completion, java.source.base, java.hints, refactoring.java, form) JavaDoc [ci] enable java/javadoc tests and build-javadoc target

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants