fix(spring): fix client and settings class names in comments#1277
Merged
emmileaf merged 2 commits intoautoconfig-gen-draft2from Jan 26, 2023
Merged
fix(spring): fix client and settings class names in comments#1277emmileaf merged 2 commits intoautoconfig-gen-draft2from
emmileaf merged 2 commits intoautoconfig-gen-draft2from
Conversation
|
Kudos, SonarCloud Quality Gate passed! |
diegomarquezp
approved these changes
Jan 26, 2023
Contributor
diegomarquezp
left a comment
There was a problem hiding this comment.
Thanks for ensuring consistency through ClassNames.
A test that compiles comments for one of the failed classes (e.g. AccessApproval[Admin]Client) and confirms the javadoc links are valid would be a nice to have.
meltsufin
approved these changes
Jan 26, 2023
Contributor
Author
@diegomarquezp Agreed - I'll merge this PR for unblocking, and follow-up on this suggestion. Were you thinking of some sort of coverage on the generator side (through golden files), or having an earlier check for javadoc links in the |
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.
This PR addresses the javadoc error observed in our attempt to set up
spring-cloud-previewsfor release.Cause of javadoc error: few exceptions of incorrect client library
<service>Clientand<service>Settingsclass namesservice.name()vs.service.overridenName()can be differentClassNames.getServiceClientClassName(service), which correctly aligns with the client library class name.service.name() + “Client”was used in other places such as javadoc comments and spring-specific methods and classnames. Turns out this assumption does not hold true.