Fix Javadoc error in ProtobufDecoder - #37079
Closed
ZaMan0806 wants to merge 1 commit into
Closed
Conversation
The @return tag in MessageSizeReader.readMessageSize() was followed by a redundant "return", which rendered as "Returns: return the message size..." in the published API documentation. Signed-off-by: BAE JAE HYEON <roblery128@gmail.com>
Member
I'm not sure why you claim that. We have released 7.0.0 through 7.0.8. Please check facts before making such statements. |
sbrannen
pushed a commit
that referenced
this pull request
Jul 21, 2026
Previously, the @return tag in MessageSizeReader.readMessageSize() was followed by a redundant "return", which rendered as "Returns: return the message size..." in the published API documentation. Closes gh-37079 Signed-off-by: BAE JAE HYEON <roblery128@gmail.com>
Contributor
|
Fixed via 1600e24 |
Member
|
This has been merged into Thanks For future reference, there is no need to supply such verbose details to explain that there's an extra "return" word in the Javadoc. |
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
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 pull request fixes a Javadoc error in
ProtobufDecoder.MessageSizeReader.readMessageSize(), where the@returntag is followed by a redundantreturn.Motivation
The
@returntag already renders as "Returns:" in the generated documentation, so the extra word is duplicated in the published API docs:The
MessageSizeReaderinterface was introduced in 7.0, so this has not appeared in a released version of the reference Javadoc yet.Modifications
returnfrom the@returntag inMessageSizeReader.readMessageSize(DataBuffer).No behavior change intended — this is a documentation-only change.
Verification
Built the Javadoc locally and confirmed the rendered output in
spring-web/build/docs/javadoc/org/springframework/http/codec/protobuf/ProtobufDecoder.MessageSizeReader.htmlbefore and after the change.