redhat-developer / redhat-developer/vscode-java

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

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

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

classpath
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ả

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

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

Không có tệp, bài kiểm thử hoặc điểm vào nào được nêu. Hãy tái tạo dự án đơn giản bằng một .jar thư viện cục bộ và .jar JavaDoc đi kèm, sau đó xác minh xem tài liệu cho các kiểu và member Java của bên thứ ba có xuất hiện trong trình soạn thảo hay không; được xem là hoàn tất khi có một cấu hình hoạt động được ghi lại hoặc một lỗi đã được xác nhận.

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, vscode
Lĩnh vực
developer-experience, documentation
Loại issue
Tài liệu
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
25/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.