redhat-developer / redhat-developer/vscode-java

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

Aperta
#813 8 commenti 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

classpath
Lingua principale
TypeScript
Stelle
2.3k
Fork
546
Merge medio
20h 1m
PR unite (30g)
11

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Non viene indicato alcun file, test o punto di ingresso. Riproduci il progetto semplice con un .jar di libreria locale e il .jar JavaDoc associato, quindi verifica se nell’editor viene visualizzata la documentazione per i tipi e i membri Java di terze parti; il lavoro è completato quando è disponibile una configurazione funzionante documentata oppure un difetto confermato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
java, vscode
Ambito
developer-experience, documentation
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.