[main-v2] Replace qdox with javac for Javadoc indexing by rkophs · Pull Request #8358 · scalameta/metals

rkophs · 2026-05-07T19:52:42Z

Context

Pulled out of #8350 -- improve JavaDox indexing while removing last vestige of qdox dep in main-v2.

Summary

Remove the qdox dependency by switching JavadocIndexer from
QdoxJavaMtags to JavacMtags
Add onClass/onMethod/onConstructor hooks and keepDocComments support to
JavacMtags so subclasses can extract Javadoc during parsing
Introduce JavadocParser utility for extracting body text and @param tags
from raw Javadoc comments
Pass full raw Javadoc to MarkdownGenerator so @param, @return, @throws,
and @see block tags now render in hover documentation
Delete QdoxJavaMtags.scala and remove the useQdox config toggle (javac
is now the only Java outline provider)

Context

This is the main-v2 counterpart to the work in #8350. Since main-v2's
JavadocIndexer still relied on qdox, this PR removes that dependency from
v2 as well by reusing the existing JavacMtags javac-based parser with
minimal additions (hooks + doc comment extraction).

coderabbitai · 2026-05-07T19:52:50Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4b6cbda0-19a0-41f0-87a3-6a47dfc9269b

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

tgodzik

Some minor comments, but looks pretty good!

tgodzik · 2026-05-08T17:02:08Z

Could you also take a look at the failing tests?

rkophs · 2026-05-09T16:37:57Z

@tgodzik Thanks for the review! addressed comments and failing tests.

tgodzik

One minor issue that I just noticed. Thanks for working on this!

@return

JavadocIndexer now extends JavacMtags instead of QdoxJavaMtags, removing the qdox dependency entirely. Added onClass/onMethod/ onConstructor hooks and keepDocComments support to JavacMtags. Uses javac's internal DocCommentTable for robust Javadoc extraction. Introduced JavadocParser for extracting body text and @param tags from raw Javadoc comments. Full raw Javadoc is now passed to MarkdownGenerator so @param, @return, @throws, and @see tags render in hover documentation. Co-Authored-By: Claude Opus 4.6 <[email protected]>

@return

…omment, update test expectations - Remove JavaOutlineProviderConfig setting entirely since javac is now the only provider - Refactor getDocComment in JavacMtags to use idiomatic Scala pattern matching instead of null checks, casts, and early returns - Update test expectations to include newly rendered @param, @return, @throws, and @see Javadoc block tags in hover and signature help output Co-Authored-By: Claude Opus 4.6 <[email protected]>

- Replace sliding(2) disambiguator with a per-name counter so non-adjacent overloads (e.g. String.valueOf interleaved with copyValueOf) get unique SemanticDB symbols instead of colliding. - Filter private constructors from disambiguation and emission, matching the previous qdox behavior. Without this, classes like java.io.File shifted public constructors' disambiguators by 2, causing the PC to read parameter names from the wrong overloads. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>

rkophs · 2026-05-19T00:25:56Z

sorry for the delay here! Should be all addressed.

ScaladocParser's HtmlConverter (Jsoup-based) strips <T> as an unknown HTML tag before the @param regex captures the param name, leaving the next word (e.g. "the", "type") as the captured name. Rewrite Javadoc `@param <T> desc` to Scaladoc `@tparam T desc` before passing the comment to MarkdownGenerator, so type parameters render correctly under Type Parameters and regular params stay under Parameters. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>

The unconditional private-constructor filter in JavacMtags caused two problems: tests.JavacMtagsExpectSuite's assertCompatWithSemanticdbJavac fails because semanticdb-javac emits private constructors, and the tests/unit/.../mtags/example/JavaClass.java fixture expects them too. The filter is only needed for JavadocIndexer's parameter-name lookup (keyed by `<init>(+N)`), which must match the Scala compiler's view of Java constructors (which excludes private ones). The base JavacMtags should match semanticdb-javac for consistent code navigation. Gate the filter behind a `filterPrivateConstructors` constructor flag, defaulting to false. JavadocIndexer opts in. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>

The Bazel MBT Java-workspace hover test now sees the `@return` block from Jsoup's Document.title() Javadoc since JavadocIndexer renders block tags. Also drop a leftover Tokens.Comment import from JavacMtags (scalafix). Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>

rkophs changed the title ~~Replace qdox with javac for Javadoc indexing~~ [main-v2] Replace qdox with javac for Javadoc indexing May 7, 2026

rkophs mentioned this pull request May 7, 2026

Replace QDox with tree-sitter for Java source parsing #8350

Closed

rkophs marked this pull request as ready for review May 7, 2026 19:54

tgodzik requested changes May 8, 2026

View reviewed changes

Comment thread metals/src/main/scala/scala/meta/internal/metals/Configs.scala Outdated

Comment thread mtags/src/main/scala/scala/meta/internal/mtags/JavacMtags.scala Outdated

rkophs force-pushed the javadoc-improvements branch from f09f88f to d538655 Compare May 9, 2026 16:20

rkophs requested a review from tgodzik May 9, 2026 16:38

tgodzik requested changes May 11, 2026

View reviewed changes

Comment thread tests/cross/src/test/scala/tests/pc/SignatureHelpDocSuite.scala Outdated

Comment thread tests/javapc/src/test/scala/hover/HoverDocSuite.scala Outdated

rkophs and others added 3 commits May 18, 2026 17:57

rkophs force-pushed the javadoc-improvements branch from 74c2cc0 to 79e1c09 Compare May 19, 2026 00:15

rkophs requested a review from tgodzik May 19, 2026 00:20

rkophs force-pushed the javadoc-improvements branch from 79e1c09 to d90e082 Compare May 19, 2026 00:28

rkophs and others added 2 commits May 19, 2026 10:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[main-v2] Replace qdox with javac for Javadoc indexing#8358

[main-v2] Replace qdox with javac for Javadoc indexing#8358
rkophs wants to merge 6 commits into
scalameta:main-v2from
rkophs:javadoc-improvements

rkophs commented May 7, 2026

Uh oh!

coderabbitai Bot commented May 7, 2026 •

edited

Loading

Review skipped

Uh oh!

tgodzik left a comment

Uh oh!

Uh oh!

Uh oh!

tgodzik commented May 8, 2026

Uh oh!

rkophs commented May 9, 2026

Uh oh!

tgodzik left a comment

Uh oh!

Uh oh!

Uh oh!

rkophs commented May 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

rkophs commented May 7, 2026

Context

Summary

Context

Uh oh!

coderabbitai Bot commented May 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Uh oh!

tgodzik left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

tgodzik commented May 8, 2026

Uh oh!

rkophs commented May 9, 2026

Uh oh!

tgodzik left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

rkophs commented May 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

coderabbitai Bot commented May 7, 2026 •

edited

Loading