Skip to content

feat: update javadocs for Client classes to include table of methods#2114

Merged
alicejli merged 23 commits intomainfrom
updateServiceClientComments
Nov 16, 2023
Merged

feat: update javadocs for Client classes to include table of methods#2114
alicejli merged 23 commits intomainfrom
updateServiceClientComments

Conversation

@alicejli
Copy link
Copy Markdown
Contributor

@alicejli alicejli commented Oct 12, 2023 •
edited
Loading

  • This updates the javadoc for generated Client classes to include a table of methods and method variants
  • This replaces the generic "API Surfaces" comments
  • As it is currently implemented, this would affect all generated Client classes (e.g. handwritten libraries would not be able to avoid this change)

Refer to cl/572240700 for staging links.

Fixes #2069 ☕️

@product-auto-label product-auto-label Bot added the size: xl Pull request size is extra large. label Oct 12, 2023
@alicejli alicejli marked this pull request as ready for review November 10, 2023 17:10
@alicejli alicejli requested review from a team, blakeli0 and burkedavison November 10, 2023 17:10
@alicejli alicejli added the owlbot:run Add this label to trigger the Owlbot post processor. label Nov 10, 2023
@gcf-owl-bot gcf-owl-bot Bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Nov 10, 2023
@burkedavison
Copy link
Copy Markdown
Member

burkedavison commented Nov 10, 2023

Staging shows non-monospaced code samples. Is this something we control?

burkedavison
burkedavison reviewed Nov 10, 2023
View reviewed changes
Comment thread .../main/java/com/google/api/generator/gapic/composer/comment/ServiceClientCommentComposer.java Outdated
Comment thread .../main/java/com/google/api/generator/gapic/composer/comment/ServiceClientCommentComposer.java Outdated
Comment thread .../main/java/com/google/api/generator/gapic/composer/comment/ServiceClientCommentComposer.java Outdated
Comment thread .../main/java/com/google/api/generator/gapic/composer/comment/ServiceClientCommentComposer.java Outdated
Comment thread .../main/java/com/google/api/generator/gapic/composer/comment/ServiceClientCommentComposer.java Outdated
Comment thread .../main/java/com/google/api/generator/gapic/composer/comment/ServiceClientCommentComposer.java Outdated
Comment thread .../main/java/com/google/api/generator/gapic/composer/comment/ServiceClientCommentComposer.java Outdated
Comment thread .../main/java/com/google/api/generator/gapic/composer/comment/ServiceClientCommentComposer.java Outdated
Comment thread .../java/com/google/api/generator/gapic/composer/common/AbstractServiceClientClassComposer.java Outdated
Comment thread .../java/com/google/api/generator/gapic/composer/common/AbstractServiceClientClassComposer.java Outdated
blakeli0
blakeli0 reviewed Nov 10, 2023
View reviewed changes
Comment thread gapic-generator-java/src/main/java/com/google/api/generator/gapic/model/Method.java Outdated
Comment thread ...com/google/api/generator/engine/writer/goldens/GrpcServiceClientWithNestedClassImport.golden
@blakeli0 blakeli0 requested a review from lqiu96 November 10, 2023 19:59
@lqiu96
Copy link
Copy Markdown
Member

lqiu96 commented Nov 10, 2023

Thanks @alicejli! FYI, I think the staging link no longer has your changes. I don't see the table anymore. Do you have a screenshot?

@alicejli
Copy link
Copy Markdown
Contributor Author

alicejli commented Nov 14, 2023 •
edited
Loading

Thanks @alicejli! FYI, I think the staging link no longer has your changes. I don't see the table anymore. Do you have a screenshot?

@lqiu96 Ah sorry about that, not sure why it's wiping the staging link. I added a link to the screenshot in the CL; please let me know if that works!

@lqiu96
Copy link
Copy Markdown
Member

lqiu96 commented Nov 14, 2023

Thanks @alicejli! FYI, I think the staging link no longer has your changes. I don't see the table anymore. Do you have a screenshot?

@lqiu96 Ah sorry about that, not sure why it's wiping the staging link. I added a link to the screenshot in the CL; please let me know if that works!

I'm able to see the changes in cl. Thanks, it looks great :)

@alicejli alicejli added the kokoro:run Add this label to force Kokoro to re-run the tests. label Nov 14, 2023
@alicejli
Copy link
Copy Markdown
Contributor Author

alicejli commented Nov 14, 2023

Staging shows non-monospaced code samples. Is this something we control?

@burkedavison Could you clarify what you mean by non-monospaced?

@alicejli alicejli added kokoro:force-run Add this label to force Kokoro to re-run the tests. and removed kokoro:run Add this label to force Kokoro to re-run the tests. labels Nov 14, 2023
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Nov 14, 2023
@burkedavison
Copy link
Copy Markdown
Member

burkedavison commented Nov 14, 2023

Staging shows non-monospaced code samples. Is this something we control?

@burkedavison Could you clarify what you mean by non-monospaced?

Issue is resolved. Previously code snippet font was set to something like Arial.

lqiu96
lqiu96 reviewed Nov 14, 2023
View reviewed changes
Comment thread gapic-generator-java/DEVELOPMENT.md
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Nov 14, 2023

[gapic-generator-java-root] Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 6 Code Smells

99.0% 99.0% Coverage
0.0% 0.0% Duplication

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Nov 14, 2023

[java_showcase_integration_tests] Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@alicejli alicejli merged commit c81cd0f into main Nov 16, 2023
@alicejli alicejli deleted the updateServiceClientComments branch November 16, 2023 15:48
@release-please release-please Bot mentioned this pull request Nov 16, 2023
Merged
@alicejli alicejli mentioned this pull request Dec 1, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@blakeli0 blakeli0 blakeli0 left review comments

@lqiu96 lqiu96 lqiu96 approved these changes

@burkedavison burkedavison burkedavison approved these changes

Assignees

No one assigned

Labels

size: xl Pull request size is extra large.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Update generated Client javadoc

5 participants

@alicejli @burkedavison @lqiu96 @blakeli0 @yoshi-kokoro