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.

Sign up for GitHub

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

Jump to bottom

feat: update JavaDoc to use @return #1233

Merged
merged 11 commits into from
Jan 11, 2023
Merged

feat: update JavaDoc to use @return #1233

merged 11 commits into from
Jan 11, 2023

Conversation

alicejli
Copy link
Contributor

@alicejli alicejli commented Jan 10, 2023 •
edited
Loading

@alicejli alicejli marked this pull request as ready for review January 10, 2023 21:19
@alicejli alicejli requested a review from a team as a code owner January 10, 2023 21:19
@alicejli alicejli requested review from zhumin8 and blakeli0 January 10, 2023 21:20
@alicejli alicejli added the owlbot:run Add this label to trigger the Owlbot post processor. label Jan 11, 2023
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Jan 11, 2023
@alicejli alicejli requested a review from suztomo January 11, 2023 16:47
meltsufin
meltsufin approved these changes Jan 11, 2023
View reviewed changes
Copy link
Member

@meltsufin meltsufin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, for void methods, it will just be null and no @return would be added, right?

@alicejli
Copy link
Contributor Author

So, for void methods, it will just be null and no @return would be added, right?

Yep; currently all the autogenerated samples from Phase 1 of SnippetGen do not even have JavaDocComments for the input parameters or return type. For the Phase 2 configured samples of SnippetGen, it will behave as you mention above: if the method is void, then it will not have a @return comment.

@sonarqubecloud
Copy link

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

100.0% 100.0% Coverage
0.0% 0.0% Duplication

@alicejli alicejli merged commit d13d3c3 into main Jan 11, 2023
@alicejli alicejli deleted the javaDocComment branch January 11, 2023 19:12
@release-please release-please bot mentioned this pull request Jan 11, 2023
Merged
lqiu96 pushed a commit that referenced this pull request Jan 11, 2023
@alicejli @ddixit14 @lqiu96
feat: update JavaDoc to use @return (#1233)
5a6a5c8 
* feat: update JavaDoc to use @return

* add another test

* add unit test for emptyComments

* remove helper comment

Co-authored-by: Deepankar Dixit <90280028+ddixit14@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@meltsufin meltsufin meltsufin approved these changes

@zhumin8 zhumin8 Awaiting requested review from zhumin8

@blakeli0 blakeli0 Awaiting requested review from blakeli0

@suztomo suztomo Awaiting requested review from suztomo

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@alicejli @meltsufin @ddixit14