redhat-developer / redhat-developer/vscode-java
Javadoc support for referencedLibraries?
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- TypeScript
- Estrellas
- 2.3k
- Forks
- 546
- Merge medio
- 20 h 1 min
- PR fusionados (30 d)
- 11
Descripción
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.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza con la configuración de referencedLibraries y reproduce la documentación que falta importando una clase y usando hover o Ctrl+click después de eliminar META-INF/maven. Se considera terminado cuando los usuarios pueden asociar un Javadoc JAR con una biblioteca referenciada y ver su documentación mediante hover.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- java, typescript, vscode
- Área
- developer-experience, tooling
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100