redhat-developer / redhat-developer/vscode-java

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

Ouverte
#813 8 commentaires 2 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

classpath
Langage dominant
TypeScript
Étoiles
2.3k
Forks
546
Merge moyen
20 h 1 min
PR mergées (30 j)
11

Description

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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Aucun fichier, test ou point d’entrée n’est indiqué. Reproduisez le projet simple avec un fichier .jar de bibliothèque local et le fichier .jar JavaDoc associé, puis vérifiez si la documentation des types et membres Java tiers apparaît dans l’éditeur ; le travail est terminé lorsqu’une configuration fonctionnelle documentée ou un défaut confirmé est obtenu.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
java, vscode
Domaine
developer-experience, documentation
Type d'issue
Documentation
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.