redhat-developer / redhat-developer/vscode-java

How to attach JavaDoc .jar for library .jar and get editor to show the documentation?

Abierto
#813 8 comentarios 2 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

classpath
Lenguaje dominante
TypeScript
Estrellas
2.3k
Forks
546
Merge medio
20 h 1 min
PR fusionados (30 d)
11

Descripción

From @mattflix on February 23, 2019 19:58

I have tried various techniques to specify the JavaDoc .jar that should be attached to a given library .jar (that appears in the "Referenced Libraries" section of the "JAVA DEPENDENCIES" view, and is successfully used by my app), but nothing has worked.

Currently, the only JavaDoc documentation that appears in the editor for me is that for the built-in objects/members, like Object and toString(). No third-party libraries seem to have any JavaDoc exposed in the editor.

Is there any example of a simple project configured with a dependency on a library .jar (that has an associated JavaDoc .jar, also located on the local file system) where the editor is able to display the documentation comments for selected Java types and members?

Copied from original issue: Microsoft/vscode-java-pack#105

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

No se especifica ningún archivo, prueba ni punto de entrada. Reproduce el proyecto sencillo con una .jar de biblioteca local y la .jar de JavaDoc asociada, y verifica si aparece documentación para los tipos y miembros de Java de terceros en el editor; se considera terminado cuando exista una configuración funcional documentada o un defecto confirmado.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
java, vscode
Área
developer-experience, documentation
Tipo de issue
Documentación
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.