redhat-developer / redhat-developer/vscode-java
Improve readability of javadoc
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.3k
- Forks
- 546
- Avg merge
- 20h 1m
- Merged PRs (30d)
- 11
Description
It would be great if we can read the javado in visual studio editor in an human readable format, instead the code format.
Current Result
Reading documentation in this format is hard.
Expected Result
Having a away to read it in an human readable format, in all objects (files in vscode or referenced through maven or gradel)
Additional Informations
If this already exists, sorry and please let me know.
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 by reproducing the JavaDoc display in the Visual Studio Code editor for Java objects from local files and dependencies referenced through Maven or Gradle. Compare the current code-formatted result with the requested human-readable format and define coverage for all referenced objects before identifying the extension entry point and suitable tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, typescript, vscode
- Domain
- developer-experience, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100