googleapis / googleapis/google-cloud-cpp
Restore missing types in reference docs
- 主要言語
- C++
- スター
- 659
- フォーク
- 462
- 平均マージ
- 1日 2時間
- マージ済み PR(30日)
- 89
説明
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.
コントリビューションガイド
調査の方向性
docfx/doxygen2yaml.cc の 62〜66 行付近から始め、@ingroup foo アノテーションを持つシンボル(MakeGoogleDefaultCredentials() を含む)の変換を再現します。google-cloud-cpp の >= v2.23.0 のバージョンについて、変換後に影響を受けるリファレンスドキュメントに不足している型が含まれていることを確認し、その後、古いバージョンへのバックポートを評価します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- cpp
- 領域
- documentation
- issue の種類
- バグ
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 45/100