redhat-developer / redhat-developer/vscode-java
Allow opening Javadoc in browser
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.3k
- Forks
- 546
- Avg merge
- 20h 1m
- Merged PRs (30d)
- 11
Description
I often want to view the Javadoc in the browser for easier reading, or to read package/module documentation (which afaik isn't easily viewable somehow inside VS Code).
Environment
- Operating System: Windows 10
- JDK version: 13.0.1
- Visual Studio Code version: 1.41.1
- Java extension version: 0.55.1
Steps To Reproduce
option 1:
- hover over an element
option 2:
- trigger autocompletion for an elemention
Current Result
option 1:
option 2:
Expected Result
I'd like for the pop-up dialogs to have an icon which opens the Javadoc of the element in the default browser. I'd already be very happy if this would work for just JDK classes, but ideally this would also work for Maven dependencies.
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
Use the hover and completion documentation popups described in the reproduction as the entry points. Check how Javadoc is resolved for JDK classes and Maven dependencies; done means both popups offer a browser action that opens the relevant Javadoc, with JDK-only support acceptable if dependency support is not available.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, vscode
- Domain
- developer-experience, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100