redhat-developer / redhat-developer/vscode-java

Load javadoc via api or local file when hover

Open
#1,020 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement javadoc ux
Dominant language
TypeScript
Stars
2.3k
Forks
546
Avg merge
20h 1m
Merged PRs (30d)
11

Description

[Hey, the excellent members of the vscode-java project team, this project is great, it helped me solve a lot of problems. The fly in the ointment is how to display javadoc through url api or local html file? Like eclipse.]

Environment
  • Operating System:linux ubuntu18
  • JDK version:1.8
  • Visual Studio Code version:
  • Java extension version:
Steps To Reproduce

no

Eclipse has this setting
20181225112626782

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are named. Start by clarifying how hover content should load javadoc from a URL API or local HTML file, using the linked Eclipse setting as the behavior reference. Done means hovering over Java symbols displays the requested javadoc source.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, typescript, vscode
Domain
developer-experience, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.