redhat-developer / redhat-developer/vscode-java

Javadoc support for referencedLibraries?

オープン
#2,984 コメント 6 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

enhancement javadoc
主要言語
TypeScript
スター
2.3k
フォーク
546
平均マージ
20時間 1分
マージ済み PR(30日)
11

説明

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
  1. 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
  2. Delete META-INF/maven from the jar
  3. Add two jars as referenced libraries to settings.json
  4. 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.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

referencedLibraries の設定から始め、META-INF/maven を削除した後にクラスをインポートし、hover または Ctrl+click を使って不足しているドキュメントを再現します。ユーザーが Javadoc JAR を参照ライブラリに関連付け、hover でそのドキュメントを表示できれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
java, typescript, vscode
領域
developer-experience, tooling
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。