Autodesk / Autodesk/AutomaticComponentToolkit
Multiline API documentation
- Ngôn ngữ chính
- Go
- Star
- 53
- Fork
- 26
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
Documentation for elements in ACT IDL is currently specified like so:
```XML
```
Having the description as an attribute makes perfect sense, but when writing an IDL file it makes it very hard to provide comprehensive documentation.
It would be nice, for example, to be able to provide documentation in element form also:
```XML
An extremely useful method.
This is an implementation of Fred Frobricator's notion of _Frobrication_, introduced in
the 1867 paper 'On Frobrication', of which you can find a copy here:
https://www.en.wikipedia.org/wiki/Frobrication
```
(Also happy with any other solution that allows for documentation in a similar for to my example, be it a different syntax for specifying an attribute of which I am unaware, special comments, or whatever.)
Hướng dẫn đóng góp
Hướng nghiên cứu
Issue không nêu tên tệp nguồn hoặc bài kiểm thử nào. Trước tiên, hãy xem xét cú pháp ACT IDL hiện tại cho phần mô tả phương thức, sau đó xác định tài liệu ở dạng phần tử nhiều dòng nên được biểu diễn như thế nào và xác minh rằng dạng đã chọn được chấp nhận và giữ nguyên toàn bộ nội dung.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Lĩnh vực
- api, documentation
- Loại issue
- Tính năng
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- 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