Improve javadoc to fix #11720 #11731
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
Fix #11720 by improving the javadoc.
janbartel
previously approved these changes
May 2, 2024
| * | ||
| * @param source the source to copy from | ||
| * @param sink the sink to copy to | ||
| * @param callback the callback to notify when the copy is complete | ||
| * @see #copy(Source, Sink, Chunk.Processor, Callback) to allows processing of individual {@link Chunk}s, including |
There was a problem hiding this comment.
Suggested change
| * @see #copy(Source, Sink, Chunk.Processor, Callback) to allows processing of individual {@link Chunk}s, including | |
| * @see #copy(Source, Sink, Chunk.Processor, Callback) to allow processing of individual {@link Chunk}s, including |
| * {@link Callback#succeeded() Succeeding} this callback will allow the processing of subsequent chunks. | ||
| * {@link Callback#failed(Throwable) Failing} this callback will fail the processing of all chunks. | ||
| * @return {@code True} if the chunk will be processed asynchronously and the callback will be called (or may have already been called), | ||
| * {@code false} otherwise, in which case subsequent chunks may be processed and the passed callback ignored. |
There was a problem hiding this comment.
Suggested change
| * {@code false} otherwise, in which case subsequent chunks may be processed and the passed callback ignored. | |
| * {@code False} otherwise, in which case subsequent chunks may be processed and the passed callback ignored. |
Or alternatively make both line 910 aand 911 lowercase
There was a problem hiding this comment.
My preference is both lower case.
sbordet
previously approved these changes
May 2, 2024
| * {@link Callback#succeeded() Succeeding} this callback will allow the processing of subsequent chunks. | ||
| * {@link Callback#failed(Throwable) Failing} this callback will fail the processing of all chunks. | ||
| * @return {@code True} if the chunk will be processed asynchronously and the callback will be called (or may have already been called), | ||
| * {@code false} otherwise, in which case subsequent chunks may be processed and the passed callback ignored. |
There was a problem hiding this comment.
My preference is both lower case.
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.
Fix #11720 by improving the javadoc.