redhat-developer / redhat-developer/vscode-java
Javadoc support for referencedLibraries?
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.3k
- Forks
- 546
- Avg merge
- 20h 1m
- Merged PRs (30d)
- 11
Description
If a non-maven/gradle library is added to referencedLibraries config (added by https://github.com/redhat-developer/vscode-java/pull/1196) - it is impossible to add the library's javadoc.
Environment
- Operating System: Tried OSX and Gentoo Linux.
- JDK version: 19
- Visual Studio Code version: 1.76.0
- Java extension version: v0.25.8
Steps To Reproduce
- Download any library from maven, e.g. https://repo1.maven.org/maven2/com/pelzer/util/pelzer-util/1.9.0/pelzer-util-1.9.0.jar and https://repo1.maven.org/maven2/com/pelzer/util/pelzer-util/1.9.0/pelzer-util-1.9.0-javadoc.jar
- Delete META-INF/maven from the jar
- Add two jars as referenced libraries to settings.json
- Import a class and hover over it or ctrl+click on it. Only bare decompiler structure shows up without documentation.
Current Result
Import a class and hover over it or ctrl+click on it. Only bare decompiler structure shows up without documentation.
Expected Result
Ability to map javadoc jars to libraries to allow for javadoc presentation on hover.
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 referencedLibraries configuration and reproduce the missing documentation by importing a class and using hover or Ctrl+click after removing META-INF/maven. Done means users can map a Javadoc JAR to a referenced library and see its documentation on hover.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, typescript, vscode
- Domain
- developer-experience, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100