use hyde as a clang-doc generator

Đang mở
  • Có gì không ổn?
#68 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

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

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
cmake, cpp
Lĩnh vực
build-system, documentation

Hướng nghiên cứu

Bắt đầu bằng việc đọc interface clang-doc Generators.h và tài liệu về clang tooling Executor, sau đó so sánh chúng với cách Hyde hiện đang xử lý các translation unit. Xác định liệu việc tích hợp clang-doc generator được yêu cầu hay hướng sử dụng external formatter có khả thi hay không; công việc được xem là hoàn tất khi có một thiết kế tích hợp đã được thống nhất và hỗ trợ cho workflow nhiều translation unit đã nêu.

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

Mô tả

Hi!

A friend of mine recommended this tool and I would like to use it on my libraries. I really like the output format, easy to read and easy to document. My only issue is integrating the tool itself into my build systems and pipelines.
My main idea was to use the compile_commands.json provided by cmake, but it seems this tool is not ready to accept multiple translation units.

Is your feature request related to a problem? Please describe.
This tool aims to provide documentation based on clang ast. There is already a similar tool in the llvm environment itself, called clang-doc. Would it be possible to merge the efforts of this project into that one?

Describe the solution you'd like
In my opinion the easiest solution would be to merge this repository into the clang-doc as a generator format. This would require minimal modification in the clang-doc itself, but would require acceptance.

Describe alternatives you've considered
Another option would be to extend clang-doc to accept external formatters, such as hyde. This would require modification in the clang-doc as right now it is not ready for that. Would also require modification in the hyde code base, but it would be very similar to the other approach. ( Fit to the Generator interface. )

Additional context
One option would be to support multiple translation units via Executor, but it would cause duplicate effort because clang-doc already does this.

Ngôn ngữ chính
C++
Star
341
Fork
45
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

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.

Issue khác của adobe/hyde

Tất cả issue của adobe/hyde

Issue tương tự

Thêm issue về C++

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.