Skip to content
This repository was archived by the owner on May 12, 2026. It is now read-only.

fix: fixed javadoc errors - #945

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

TimurSadykov merged 10 commits into
googleapis:mainfrom
aeitzman:java-doc-fix

Conversation

@aeitzman

Copy link
Copy Markdown
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
Copy Markdown

@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.

@TimurSadykov TimurSadykov left a comment

Copy link
Copy Markdown

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 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

@TimurSadykov TimurSadykov left a comment

Copy link
Copy Markdown

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

Comment thread oauth2_http/java/com/google/auth/oauth2/CredentialAccessBoundary.java Outdated
Comment thread oauth2_http/java/com/google/auth/oauth2/CredentialAccessBoundary.java Outdated
Comment thread oauth2_http/java/com/google/auth/oauth2/CredentialAccessBoundary.java Outdated
@TimurSadykov
TimurSadykov merged commit 1ddc994 into googleapis:main Oct 14, 2022
gcf-merge-on-green Bot pushed a commit that referenced this pull request Oct 17, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

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