MINOR: Fix incomplete Javadoc comments in storage module #20778
+3
−3
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
- Add missing @return description in ProducerManager.publishMessage() - Add missing @return description in RemoteLogMetadataCache.listAllRemoteLogSegments() - Add missing @throws description in LogDirFailureChannel.takeNextOfflineLogDir() All Javadoc tags now have proper descriptions following Apache Kafka documentation standards.
github-actions
bot
added
triage
|
@atheendre130505 Thanks for the contribution. Could you follow the guide to modify PR title? Thanks. https://cwiki.apache.org/confluence/display/KAFKA/Contributing+Code+Changes |
|
A label of 'needs-attention' was automatically added to this PR in order to raise the |
atheendre130505
changed the title
|
@chia7712 @FrankYang0529 All checks have passed. Ready for merge. Thanks! |
|
A label of 'needs-attention' was automatically added to this PR in order to raise the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 PR addresses incomplete Javadoc comments in the storage module. It
adds proper descriptions to all relevant Javadoc tags according to
Apache Kafka documentation standards:
Adds missing @return description in ProducerManager.publishMessage()
Adds missing @return description in
RemoteLogMetadataCache.listAllRemoteLogSegments()
Adds missing @throws description in
LogDirFailureChannel.takeNextOfflineLogDir()
No functional code changes are introduced. All updates are strictly to
improve code documentation clarity and compliance.