fix: fixed javadoc errors#945
Merged
TimurSadykov merged 10 commits intogoogleapis:mainfrom Oct 14, 2022
Merged
Conversation
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 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
approved these changes
Oct 13, 2022
TimurSadykov
left a comment
There was a problem hiding this comment.
Some nit suggestions, LGTM otherwise
gcf-merge-on-green Bot
pushed a commit
that referenced
this pull request
Oct 17, 2022
🤖 I have created a release *beep* *boop* --- ## [1.12.0](https://togithub.com/googleapis/google-auth-library-java/compare/v1.11.0...v1.12.0) (2022-10-14) ### Features * Adding validation for psc endpoints ([#1042](https://togithub.com/googleapis/google-auth-library-java/issues/1042)) ([b37a565](https://togithub.com/googleapis/google-auth-library-java/commit/b37a565c6c1e7acb44baf2307c862c9df8be9345)) ### Bug Fixes * Fixed javadoc errors ([#945](https://togithub.com/googleapis/google-auth-library-java/issues/945)) ([1ddc994](https://togithub.com/googleapis/google-auth-library-java/commit/1ddc99481ae8b0f0eceb4cb442d5c6614ec8a411)) ### Documentation * **samples:** Modified comments in the samples and minor refactor ([#990](https://togithub.com/googleapis/google-auth-library-java/issues/990)) ([669ab04](https://togithub.com/googleapis/google-auth-library-java/commit/669ab042844e46d0503bbd31fd2da92a7963bad5)) --- This PR was generated with [Release Please](https://togithub.com/googleapis/release-please). See [documentation](https://togithub.com/googleapis/release-please#release-please).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 ☕️