Add implementation reference to interface parameter declaration in JavaDoc #346
Conversation
This file contains 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
MatKuhr
approved these changes
Mar 6, 2024
CharlesDuboisSAP
previously requested changes
Mar 6, 2024
| @@ -61,6 +61,8 @@ public interface BuilderWithTokenEndpoint | |||
| * @param behalf | |||
| * The OAuth2 token representative. | |||
| * @return The same builder instance. | |||
| * @see com.sap.cloud.security.config.ClientCertificate | |||
| * @see com.sap.cloud.security.config.ClientCredentials | |||
| * @since 4.10.0 | |||
There was a problem hiding this comment.
I would rather add:
* @param clientIdentity
* The OAuth2 Client Identity. Can be instantiated from a {@link ClientCredentials}.
There was a problem hiding this comment.
if we do that we should mention both implementations I'd think.. But personally I'm also a fan of the @see to point to related stuff, we can also do both 😉
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Related
https://github.com/orgs/SAP/projects/62/views/5?pane=issue&itemId=55522157
Not sure whether this brings any benefit. But the user was unable to locate the implementation classes by themselves.