Align method descriptions for SslOptions getCiphers and getEnabledProtocols with '@returns' #46756
+3
−2
Conversation
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
spring-projects-issues
added
the
status: waiting-for-triage
ganjisriver
force-pushed
the
fix-ssloptions-document
branch
from
b7d9704 to
d502b3a
Compare
Signed-off-by: 강정훈 Kang Jeonghun <ganjisriver18@gmail.com>
ganjisriver
force-pushed
the
fix-ssloptions-document
branch
from
d502b3a to
37892e8
Compare
snicoll
added
type: documentation
snicoll
changed the title
snicoll
pushed a commit
that referenced
this pull request
Aug 11, 2025
See gh-46756 Signed-off-by: 강정훈 Kang Jeonghun <ganjisriver18@gmail.com>
snicoll
added a commit
that referenced
this pull request
Aug 11, 2025
|
@ganjisriver thank you for making your first contribution to Spring Boot. |
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.
Description
This pull request aligns the Javadoc description of
SslOptions.getCiphers()andSslOptions.getEnabledProtocols()with their@returntags.Currently, the method descriptions state that they return an "empty set," while the
@returntag correctly specifies that they returnnull. This change resolves the discrepancy by updating the description to explicitly state that the methods returnnullwhen no options are specified, which is consistent with the current implementation.Before:
Return the ciphers that can be used or an empty set.Return the protocols that should be enabled or an empty set.After:
Return the ciphers that can be used or null.Return the protocols that should be enabled or null.ref. issue 46660