Skip to content

Fix Javadoc error in ProtobufDecoder - #37079

Closed
ZaMan0806 wants to merge 1 commit into
spring-projects:mainfrom
ZaMan0806:fix-javadoc-protobuf-decoder
Closed

Fix Javadoc error in ProtobufDecoder#37079
ZaMan0806 wants to merge 1 commit into
spring-projects:mainfrom
ZaMan0806:fix-javadoc-protobuf-decoder

Conversation

@ZaMan0806

Copy link
Copy Markdown
Contributor

This pull request fixes a Javadoc error in ProtobufDecoder.MessageSizeReader.readMessageSize(), where the @return tag is followed by a redundant return.

Motivation

The @return tag already renders as "Returns:" in the generated documentation, so the extra word is duplicated in the published API docs:

Returns:
return the message size, or null if the data in the input buffer was insufficient

The MessageSizeReader interface was introduced in 7.0, so this has not appeared in a released version of the reference Javadoc yet.

Modifications

  • Removed the redundant return from the @return tag in MessageSizeReader.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.html
before and after the change.

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>
@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged or decided on label Jul 21, 2026
@sbrannen sbrannen self-assigned this Jul 21, 2026
@sbrannen sbrannen added type: documentation A documentation task in: core Issues in core modules (aop, beans, core, context, expression) and removed status: waiting-for-triage An issue we've not yet triaged or decided on labels Jul 21, 2026
@sbrannen sbrannen added this to the 7.0.9 milestone Jul 21, 2026
@sbrannen

Copy link
Copy Markdown
Member

The MessageSizeReader interface was introduced in 7.0, so this has not appeared in a released version of the reference Javadoc yet.

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 sbrannen added in: web Issues in web modules (web, webmvc, webflux, websocket) and removed in: core Issues in core modules (aop, beans, core, context, expression) labels Jul 21, 2026
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>
@github-actions

Copy link
Copy Markdown
Contributor

Fixed via 1600e24

@github-actions github-actions Bot closed this Jul 21, 2026
@sbrannen

Copy link
Copy Markdown
Member

This has been merged into 7.0.x and main.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

in: web Issues in web modules (web, webmvc, webflux, websocket) type: documentation A documentation task

3 participants