Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restore missing types in reference docs #14412

Open
dbolduc opened this issue Jul 1, 2024 · 0 comments
Open

Restore missing types in reference docs #14412

dbolduc opened this issue Jul 1, 2024 · 0 comments
Labels
cpp: docfx Improvements for the DocFX tool cpp: operator Good things for the operator to fix type: cleanup An internal cleanup or hygiene concern.

Comments

@dbolduc
Copy link
Member

dbolduc commented Jul 1, 2024

Certain symbols (e.g. MakeGoogleDefaultCredentials()) are missing from our reference docs. The missing types have an @ingroup foo. Doxygen renders these as <member> tags, which we skip in our docfx -> yaml conversion:

// Starting with Doxygen 1.9.7 any namespace members that are defined
// in a group appear as `member` children in the namespace, with just a
// `refid` pointing to its location. We need to skip these. They lack
// enough information to create a valid YAML element describing them.
"member",

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.

@dbolduc dbolduc added type: cleanup An internal cleanup or hygiene concern. cpp: operator Good things for the operator to fix cpp: docfx Improvements for the DocFX tool labels Jul 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cpp: docfx Improvements for the DocFX tool cpp: operator Good things for the operator to fix type: cleanup An internal cleanup or hygiene concern.
Projects
None yet
Development

No branches or pull requests

1 participant