Adding JavaDoc #396
Merged
Adding JavaDoc #396
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
xerial
reviewed
Nov 4, 2016
| * </table> | ||
| * | ||
| * <p> | ||
| * Complex methods: |
Member
There was a problem hiding this comment.
The word complex has a little bit negative image. We can say this as convenience, utility or helper method.
xerial
reviewed
Nov 4, 2016
| /** | ||
| * Writes header of a Binary value. | ||
| * <p> | ||
| * You will call {@link #writePayload(byte[])} or {@link #addPayload(byte[])} method to write body binary. |
xerial
reviewed
Nov 4, 2016
| * break; | ||
| * case EXTENSION: | ||
| * extension = unpacker.unpackExtensionTypeHeader(); | ||
| * unpacker.readPayload(new byte[extension.getLength()]); |
Member
There was a problem hiding this comment.
readPayload(byte[]) should be modified to return byte[]. Currently it returns void
xerial
reviewed
Nov 4, 2016
| * case ARRAY: | ||
| * length = unpacker.unpackArrayHeader(); | ||
| * for (int i = 0; i < length; i++) { | ||
| * readRecursively(unpack); |
xerial
reviewed
Nov 4, 2016
| * case MAP: | ||
| * length = unpacker.unpackMapHeader(); | ||
| * for (int i = 0; i < length; i++) { | ||
| * readRecursively(unpack); // key |
xerial
reviewed
Nov 4, 2016
| * </table> | ||
| * | ||
| * <p> | ||
| * To read a byte array, first you call {@link #unpackBinaryHeader} method to get length of the byte array. Then, |
Member
There was a problem hiding this comment.
Even if we remove two yous, it still makes sense
xerial
reviewed
Nov 4, 2016
| * | ||
| * <p> | ||
| * To read an Array type, first you call {@link #unpackArrayHeader()} method to get number of elements. Then, | ||
| * you call unpacker methods for each element. |
xerial
reviewed
Nov 4, 2016
| * | ||
| * @return the next MessageFormat | ||
| * @throws IOException when failed to read the input data. | ||
| * @throws IOException when underlaying input throws IOException |
Member
Author
There was a problem hiding this comment.
👍 Fixed the typo in all files.
xerial
reviewed
Nov 4, 2016
| public void readPayload(byte[] dst) | ||
| throws IOException | ||
| { | ||
| readPayload(dst, 0, dst.length); |
Member
There was a problem hiding this comment.
Should we return the dst byte array here so that we can use this method like readPayload(new byte[...])?
Member
Author
There was a problem hiding this comment.
I think people will use readPayload(int) for that use case. It's already there. So, I think it's ok to return void here. Having consistency with readPayload(byte[], int off, int len) might be more important to avoid confusion.
xerial
reviewed
Nov 4, 2016
| } | ||
|
|
||
| /** | ||
| * Gets size of the written data. |
xerial
reviewed
Nov 4, 2016
| } | ||
|
|
||
| /** | ||
| * Gets copy of the written data as a byte array. |
xerial
reviewed
Nov 4, 2016
| * array-backed buffers. | ||
| * <p> | ||
| * MessageBuffer class itself is optimized for little-endian CPU archtectures so that JVM (HotSpot) can take advantage | ||
| * of the fastest JIT format which skips TypeProfile checking. To ensure this performance, applications must not load |
xerial
reviewed
Nov 4, 2016
| * | ||
| * @param array the byte array that will gack this MessageBuffer | ||
| * @return | ||
| * @return the new MessageBuffer |
Member
There was a problem hiding this comment.
the -> a new MessageBuffer that wraps the given byte array
xerial
reviewed
Nov 4, 2016
| * @param offset The offset of the subarray to be used; must be non-negative and no larger than array.length | ||
| * @param length The length of the subarray to be used; must be non-negative and no larger than array.length - offset | ||
| * @return | ||
| * @return the new MessageBuffer |
xerial
reviewed
Nov 4, 2016
| * @throws IllegalArgumentException given byte buffer returns false both from hasArray() and isDirect() | ||
| * @throws UnsupportedOperationException given byte buffer is a direct buffer and this platform doesn't support Unsafe API | ||
| * @return | ||
| * @return the new MessageBuffer |
xerial
reviewed
Nov 4, 2016
|
|
||
| /** | ||
| * byte size of the buffer | ||
| * Gets size of the buffer. |
frsyuki
commented
Nov 27, 2016
| * </table> | ||
| * | ||
| * <p> | ||
| * Complex methods: |
| /** | ||
| * Writes header of a Binary value. | ||
| * <p> | ||
| * You will call {@link #writePayload(byte[])} or {@link #addPayload(byte[])} method to write body binary. |
| * case ARRAY: | ||
| * length = unpacker.unpackArrayHeader(); | ||
| * for (int i = 0; i < length; i++) { | ||
| * readRecursively(unpack); |
| * case MAP: | ||
| * length = unpacker.unpackMapHeader(); | ||
| * for (int i = 0; i < length; i++) { | ||
| * readRecursively(unpack); // key |
| * </table> | ||
| * | ||
| * <p> | ||
| * To read a byte array, first you call {@link #unpackBinaryHeader} method to get length of the byte array. Then, |
| * array-backed buffers. | ||
| * <p> | ||
| * MessageBuffer class itself is optimized for little-endian CPU archtectures so that JVM (HotSpot) can take advantage | ||
| * of the fastest JIT format which skips TypeProfile checking. To ensure this performance, applications must not load |
| * | ||
| * @param array the byte array that will gack this MessageBuffer | ||
| * @return | ||
| * @return the new MessageBuffer |
| * @param offset The offset of the subarray to be used; must be non-negative and no larger than array.length | ||
| * @param length The length of the subarray to be used; must be non-negative and no larger than array.length - offset | ||
| * @return | ||
| * @return the new MessageBuffer |
| * @throws IllegalArgumentException given byte buffer returns false both from hasArray() and isDirect() | ||
| * @throws UnsupportedOperationException given byte buffer is a direct buffer and this platform doesn't support Unsafe API | ||
| * @return | ||
| * @return the new MessageBuffer |
|
|
||
| /** | ||
| * byte size of the buffer | ||
| * Gets size of the buffer. |
Member
|
👍 |
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 PR adds JavaDoc to common public methods and classes.
I built JavaDoc using sbt's
~doccommand.