grpc-protoc fix missing javadoc #2144
Merged
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
Motivation: `addService(BlockingX)` was deprecated and javadocs were added to indicate this. However we need to add javadocs for all params/return value or else javadoc lint warnings will be generated.
This was referenced Mar 10, 2022
servicetalk-grpc-protoc/src/main/java/io/servicetalk/grpc/protoc/Generator.java
Outdated
Show resolved
Hide resolved
Scottmitch
commented
Mar 10, 2022
| if (printJavaDocs) { | ||
| extractJavaDocComments(state, methodIndex, b); | ||
| b.addJavadoc(JAVADOC_PARAM + metadata + | ||
| b.addJavadoc(JAVADOC_DEPRECATED + "Use {@link #$L($T,$T)}." + lineSeparator(), |
There was a problem hiding this comment.
I moved this to be conditional, however adding it to the end of this block won't make it after all the params because there are params added after this function is called. we can add additional callback to add deprecated in the right place but I'm not sure it is worth the additional complexity for something we will be removing...
idelpivnitskiy
approved these changes
Mar 10, 2022
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.
Motivation:
addService(BlockingX)was deprecated and javadocs wereadded to indicate this. However we need to add javadocs for
all params/return value or else javadoc lint warnings will
be generated.