microsoft / microsoft/vscode-java-dependency

Attach javadoc to manually added referenced libraries

Open
#440 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
199
Forks
105
Avg merge
1d 22h
Merged PRs (30d)
27

Description

We can add a referenced library (jar) using the Project Manager or by manually editing .vscode\settings.
Please add the ability to attach the library's javadocs as well.

In my use case, I have the jar and its javadocs, but I do not have its source code. I'd love to be able to see the javadocs for this library while editing java code.

Thanks.

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

Review the Project Manager flow and manually edited .vscode\settings handling for referenced JARs. Determine how a JAR's separate Javadocs should be associated, then verify in a Java editing session that documentation is available without source code.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, typescript
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.