Javadoc comments not appearing in VSCode

[lukehutch]

JavaDoc comments are not working in VS Code. (Incidentally this applies to both the Anthropic and OpenAI Java APIs.)

My pom.xml:

        <dependency>
            <groupId>com.openai</groupId>
            <artifactId>openai-java</artifactId>
            <version>0.39.0</version>
        </dependency>
        <dependency>
            <groupId>com.anthropic</groupId>
            <artifactId>anthropic-java</artifactId>
            <version>0.9.2</version>
        </dependency>

A screenshot showing there is no JavaDoc:

Browsing to that class, it is definitely missing JavaDoc, at least as it is pulled in by VS Code (is this decompiled or something??):

[TomerAberbach]

Yeah that definitely looks decompiled.

Which vscode plug-in are you using?

[lukehutch]

Just the standard Red Hat Java plug-in for visual studio code.

[TomerAberbach]

Do you have java.maven.downloadSources enabled?

[lukehutch]

Weirdly, that was disabled. I enabled it, clean-rebuilt everything, restarted VS Code, and still have the problem.

[TomerAberbach]

So I played around with this on my machine and couldn't get things working in VSCode. I then did some research and it appears that the VSCode Java extensions simply do not support navigating to or extracting javadocs from Kotlin dependency sources.

I wish I had a better answer, but that seems to be the reality at the moment. I think your main options right now are:

1. Live with it and browse the javadocs published to javadoc.io outside your editor
2. Switch to IntelliJ

I also want to note that we've been wanting to rewrite the public API of the SDK in Java (while keeping the internals in Kotlin) for various other reasons and this issue only adds to the reasons we would want to do that. Unfortunately I don't have an ETA for that right now.

[lukehutch]

Thanks for taking a look. Wow, that's crazy! Do you know the reason for the breakage? I want to report this upstream, but don't have a clue where to report it to.

You can probably convert the code in bulk easily using Claude Code.

[TomerAberbach]

Thanks for taking a look. Wow, that's crazy! Do you know the reason for the breakage? I want to report this upstream, but don't have a clue where to report it to.

As far as I know it's never worked in VSCode... I think this issue is related: redhat-developer/vscode-java#531

You can probably convert the code in bulk easily using Claude Code.

Yeah, I think that would work if we were just targeting this SDK, but we wanna make the change in the Stainless code generator, which will take more time of course (and is less amenable to being done by Claude Code)

[lukehutch]

I had no idea, I assumed that Kotlin was fully interoperable with Java. In that case, since you are generating the code with Stainless, maybe not just the exposed API classes but the entire generated codebase should be in Java...