redhat-developer / redhat-developer/vscode-java
Javadoc support for referencedLibraries?
Personne n'a encore pris cette issue.
- Langage dominant
- TypeScript
- Étoiles
- 2.3k
- Forks
- 546
- Merge moyen
- 20 h 1 min
- PR mergées (30 j)
- 11
Description
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.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par la configuration de referencedLibraries et reproduisez la documentation manquante en important une classe et en utilisant hover ou Ctrl+click après avoir supprimé META-INF/maven. C’est terminé lorsque les utilisateurs peuvent associer un Javadoc JAR à une bibliothèque référencée et voir sa documentation au survol.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- java, typescript, vscode
- Domaine
- developer-experience, tooling
- Type d'issue
- Fonctionnalité
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100