googleapis / googleapis/google-cloud-cpp
Restore missing types in reference docs
- Ngôn ngữ chính
- C++
- Star
- 659
- Fork
- 462
- Merge trung bình
- 1 ngày 2 giờ
- Pull request đã merge (30 ngày)
- 89
Mô tả
Certain symbols (e.g. `MakeGoogleDefaultCredentials()`) are missing from our reference docs. The missing types have an `@ingroup foo`. Doxygen renders these as `` tags, which we skip in our docfx -> yaml conversion:
https://github.com/googleapis/google-cloud-cpp/blob/4ce192283831c5f0d815b84462bb53fa294a03af/docfx/doxygen2yaml.cc#L62-L66
The docs for `google-cloud-cpp` version >= `v2.23.0` are affected. When we have a fix, we ought to backport it to the older versions.
Hướng dẫn đóng góp
Hướng nghiên cứu
Bắt đầu tại docfx/doxygen2yaml.cc, quanh các dòng 62-66, và tái hiện quá trình chuyển đổi đối với các symbol có annotation @ingroup foo, bao gồm MakeGoogleDefaultCredentials(). Xác minh rằng các tài liệu tham chiếu bị ảnh hưởng của các phiên bản google-cloud-cpp >= v2.23.0 có chứa các type còn thiếu sau khi chuyển đổi, sau đó đánh giá việc backport sang các phiên bản cũ hơ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ệ
- cpp
- Lĩnh vực
- documentation
- Loại issue
- Lỗi
- Độ 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
- 45/100