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

Generator doxygen comments include broken links #7664

Closed
coryan opened this issue Nov 24, 2021 · 5 comments · Fixed by #10687
Closed

Generator doxygen comments include broken links #7664

coryan opened this issue Nov 24, 2021 · 5 comments · Fixed by #10687
Assignees
Labels
cpp: generator Issues related to the C++ micro-generator type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.

Comments

@coryan
Copy link
Contributor

coryan commented Nov 24, 2021

The documentation as rendered looks like this:

https://googleapis.dev/cpp/google-cloud-iam/1.33.0/classgoogle_1_1cloud_1_1iam_1_1IAMClient.html#a317a11faf4b5ad519550a6764dcfac3c

It seems like this is attempting to use markdown link aliases, e.g. [ServiceAccount][google.iam.admin.v1.ServiceAccount], but the link aliases are not defined in the Doxygen block:

/**
* Creates a [ServiceAccount][google.iam.admin.v1.ServiceAccount].
*
* @param name Required. The resource name of the project associated with the
* service accounts, such as `projects/my-project-123`.
* @param account_id Required. The account id that is used to generate the
* service account email address and a stable unique id. It is unique within a
* project, must be 6-30 characters long, and match the regular expression
* `[a-z]([-a-z0-9]*[a-z0-9])` to comply with RFC1035.
* @param service_account The
* [ServiceAccount][google.iam.admin.v1.ServiceAccount] resource to create.
* Currently, only the following values are user assignable: `display_name`
* and `description`.
* @return
* [google::iam::admin::v1::ServiceAccount](https://github.com/googleapis/googleapis/blob/9bac62dbc7a1f7b19baf578d6fbb550dbaff0d49/google/iam/admin/v1/iam.proto#L461)
*/

Note that the previous references are to the v1.33.0 release, but this is still the case on main.

@coryan coryan added type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. priority: p2 Moderately-important priority. Fix may not be included in next release. cpp: generator Issues related to the C++ micro-generator labels Nov 24, 2021
@coryan
Copy link
Contributor Author

coryan commented Nov 24, 2021

Ah, it seems these link aliases are taken verbatim from the proto comments:

https://github.com/googleapis/googleapis/blob/9a04fde55ca0b57bdb34cbc1716e52274a690169/google/iam/admin/v1/iam.proto#L79

@coryan coryan added type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. and removed type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. priority: p2 Moderately-important priority. Fix may not be included in next release. labels Nov 24, 2021
@coryan
Copy link
Contributor Author

coryan commented Nov 24, 2021

Since this is just copying the comments verbatim, it is really a feature request, not a bug.

@coryan
Copy link
Contributor Author

coryan commented May 26, 2022

One possible "fix" is to make these links not look like links. Maybe the move to stored the docs in cloud.google.com will fix this too.

@coryan
Copy link
Contributor Author

coryan commented Sep 28, 2022

This looks fixed.

@coryan coryan closed this as completed Sep 28, 2022
@coryan coryan reopened this Jan 25, 2023
@coryan
Copy link
Contributor Author

coryan commented Jan 25, 2023

It is not fixed, for example look at:

https://googleapis.dev/cpp/google-cloud-secretmanager/latest/classgoogle_1_1cloud_1_1secretmanager_1_1SecretManagerServiceClient.html#aab81903782c1a0f0354bbfd851ace46d

Apparently I fixed the request and response types used in each method, but not any additional references.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cpp: generator Issues related to the C++ micro-generator type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant