Skip to content

fix: fixed javadoc errors#945

Merged
TimurSadykov merged 10 commits intogoogleapis:mainfrom
aeitzman:java-doc-fix
Oct 14, 2022
Merged

fix: fixed javadoc errors#945
TimurSadykov merged 10 commits intogoogleapis:mainfrom
aeitzman:java-doc-fix

Conversation

@aeitzman
Copy link
Contributor

Update javadoc source version to 8 and modified configuration to ignore 'missing' javadoc comments since missing unnecessary @returns are getting flagged as an error.

Fixes #909 ☕️

Update javadoc source version to 8 and modified configuration to ignore 'missing' javadoc comments since missing unnecessary @returns are getting flagged as an error.
@aeitzman aeitzman requested a review from a team July 13, 2022 20:57
@product-auto-label product-auto-label bot added the size: s Pull request size is small. label Jul 13, 2022
@lsirac lsirac requested a review from TimurSadykov July 14, 2022 16:28
@TimurSadykov
Copy link

@aeitzman the fix is too coarse. Half of the warning are due to missing @params, we want those fixed. Same for @returns. It might be optional for builder etc, but not in general.

I suggest we better fix the docs, then disable the check. You can cover only ExternalAccountCredential, CredentialAccessBoundary and I will cover the rest.

Copy link

@TimurSadykov TimurSadykov left a comment

Choose a reason for hiding this comment

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

see above comment

@lsirac lsirac requested a review from a team as a code owner July 26, 2022 21:49
@product-auto-label product-auto-label bot added size: m Pull request size is medium. and removed size: s Pull request size is small. labels Oct 5, 2022
Copy link

@TimurSadykov TimurSadykov left a comment

Choose a reason for hiding this comment

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

Some nit suggestions, LGTM otherwise

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size: m Pull request size is medium.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Include missing javadoc comments

3 participants