redhat-developer / redhat-developer/vscode-java
Javadocs not displaying on hover
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.3k
- Forks
- 546
- Avg merge
- 20h 1m
- Merged PRs (30d)
- 11
Description
Hello, I have encountered an issue with displaying Javadocs on hover. I have narrowed down the problem to a single dependency that breaks the hover functionality for some classes/methods.
Environment
- Operating System: Puppy Linux F96-CE
- JDK version: IBM Semeru Runtime Open Edition 21.0.1.0 (build 21.0.1+12-LTS)
- Visual Studio Code version: 1.87.2
- Java extension version: 1.28.1
Steps To Reproduce
- [step 1] Open attached sample project
- [step 2] Hover on Spring annotations or
DiscordJarinprivate static final DiscordJar api
[Please attach a sample project reproducing the error]
sample-project.zip
client.log.2024-03-20.txt
log.txt
Current Result
Javadocs don't appear on hover
Expected Result
Javadocs appear on hover
Additional Informations
A lone direct dependency on spring-boot results in javadocs displaying for Spring annotations.
A direct dependency on spring-boot + dependency on discord.jar results in javadocs not displaying for Spring annotations nor discord.jar types.
A lone dependency on discord.jar results in javadocs not displaying for its own types (ex. DiscordJar) but they are present when viewed via Go to Definition or viewing some methods in code completion.
Using any transitive dependencies from discord.jar has their javadocs not appear (ex. Gson).
Signature help does display the javadocs as well, but not all of them (Spring annotations still don't show).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the attached sample-project.zip and reproduce the hover behavior on Spring annotations and DiscordJar. Read client.log.2024-03-20.txt and log.txt alongside the dependency combinations described in the issue; done means Javadocs appear on hover for the affected Spring, DiscordJar, and transitive dependency types.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, vscode
- Domain
- developer-experience, tooling
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100