redhat-developer / redhat-developer/vscode-java
Javadoc support for referencedLibraries?
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 2.3k
- Forks
- 546
- Ø Merge
- 20 Std. 1 Min.
- Gemergte PRs (30 T.)
- 11
Beschreibung
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der Konfiguration von referencedLibraries und reproduziere die fehlende Dokumentation, indem du nach dem Entfernen von META-INF/maven eine Klasse importierst und Hover oder Ctrl+click verwendest. Erledigt ist es, wenn Benutzer ein Javadoc JAR einer referenzierten Bibliothek zuordnen und dessen Dokumentation per Hover anzeigen können.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- java, typescript, vscode
- Bereich
- developer-experience, tooling
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100