redhat-developer / redhat-developer/vscode-java

Javadoc support for referencedLibraries?

Đang mở
#2,984 6 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

enhancement javadoc
Ngôn ngữ chính
TypeScript
Star
2.3k
Fork
546
Merge trung bình
20 giờ 1 phút
Pull request đã merge (30 ngày)
11

Mô tả

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.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu với cấu hình referencedLibraries và tái hiện phần tài liệu còn thiếu bằng cách import một class và sử dụng hover hoặc Ctrl+click sau khi xóa META-INF/maven. Hoàn thành khi người dùng có thể ánh xạ một Javadoc JAR với một thư viện được tham chiếu và xem tài liệu của thư viện đó khi hover.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
java, typescript, vscode
Lĩnh vực
developer-experience, tooling
Loại issue
Tính năng
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
35/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.