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

Remove proto code reference from javadoc comments #1002

Closed
eaball35 opened this issue Jun 7, 2022 · 2 comments
Closed

Remove proto code reference from javadoc comments #1002

eaball35 opened this issue Jun 7, 2022 · 2 comments
Assignees
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.

Comments

@eaball35
Copy link
Contributor

eaball35 commented Jun 7, 2022

Referring to the proto in the javadoc comments doesn't add much value for external users and can be confusing in reference docs. I think we can just remove including this entirely from generation.

<code>.google.devtools.clouderrorreporting.v1beta1.ErrorContext context = 5;</code>

https://github.com/googleapis/java-errorreporting/blob/main/proto-google-cloud-error-reporting-v1beta1/src/main/java/com/google/devtools/clouderrorreporting/v1beta1/ErrorEventOrBuilder.java#L159

https://cloud.google.com/java/docs/reference/google-cloud-errorreporting/latest/com.google.devtools.clouderrorreporting.v1beta1.ErrorEventOrBuilder

@eaball35 eaball35 added type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. priority: p3 Desirable enhancement or fix. May not be included in next release. labels Jun 7, 2022
@blakeli0
Copy link
Collaborator

blakeli0 commented Jun 7, 2022

If this file is in the proto folder, I think it is generated by the java_proto_library which is not the responsibility of this repo. Maybe this repo?

@blakeli0 blakeli0 self-assigned this Aug 2, 2022
@blakeli0
Copy link
Collaborator

blakeli0 commented Aug 2, 2022

This code is generated by the Bazel protobuf plugin, not the Java micro generator. Please feel free to open another issue in https://github.com/protocolbuffers/protobuf if you still think this is an issue.

@blakeli0 blakeli0 closed this as completed Aug 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.
Projects
None yet
Development

No branches or pull requests

2 participants