HBASE-22725 Remove all remaining javadoc warnings #463
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
|
💔 -1 overall
This message was automatically generated. |
HorizonNet
requested changes
Aug 7, 2019
Contributor
HorizonNet
left a comment
HorizonNet
left a comment
There was a problem hiding this comment.
LGTM overall, but left a few suggestions for improvements.
| * @return either Include {@link ReturnCode} or Skip {@link ReturnCode} | ||
| * @param loc the destination of data | ||
| * @param heapSizeOfRow the data size | ||
| * @return either Include {@link RequestController.ReturnCode} or Skip |
Contributor
There was a problem hiding this comment.
NIT: "skip" (lower 's').
| /** | ||
| * @param tableName the name of the table | ||
| * @param startKey the start key of the region | ||
| * @param stopKey the start key of the region |
Contributor
There was a problem hiding this comment.
the stop key of the region.
| * @param stopKey the start key of the region | ||
| * @param callingMethod the name of the calling method probably a test method | ||
| * @param conf the configuration to use | ||
| * @param isReadOnly true if the table is read only, false otherwise |
Contributor
There was a problem hiding this comment.
Suggestion: Use {@code true} and {@code false} instead.
| * @throws IOException if an IO problem is encountered | ||
| * @return A region on which you must call {@link HBaseTestingUtility#closeRegionAndWAL(HRegion)} | ||
| * when done. | ||
| * @deprecated since 2.0.0 and will be removed in 3.0.0. Use |
Contributor
There was a problem hiding this comment.
The indentation is wrong.
Contributor
There was a problem hiding this comment.
This should also fix the Checkstyle violation.
| * @deprecated since 2.0.0 and will be removed in 3.0.0. Use | ||
| * {@link HBaseTestingUtility#createLocalHRegion(TableName, byte[], byte[], boolean, Durability, WAL, byte[]...)} | ||
| * instead. | ||
| * @see HBaseTestingUtility#createLocalHRegion(TableName, byte[], byte[], boolean, Durability, WAL, byte[]...) |
| * {@link HBaseTestingUtility#createLocalHRegion(TableName, byte[], byte[], boolean, Durability, WAL, byte[]...)} | ||
| * instead. | ||
| * @see HBaseTestingUtility#createLocalHRegion(TableName, byte[], byte[], boolean, Durability, WAL, byte[]...) | ||
| * @see <a href="https://issues.apache.org/jira/browse/HBASE-13893">HBASE-13893</a> |
|
💔 -1 overall
This message was automatically generated. |
|
💔 -1 overall
This message was automatically generated. |
|
💔 -1 overall
This message was automatically generated. |
|
💔 -1 overall
This message was automatically generated. |
Contributor
Author
|
@HorizonNet |
|
💔 -1 overall
This message was automatically generated. |
|
💔 -1 overall
This message was automatically generated. |
|
💔 -1 overall
This message was automatically generated. |
|
🎊 +1 overall
This message was automatically generated. |
saintstack
approved these changes
Aug 11, 2019
Contributor
saintstack
left a comment
saintstack
left a comment
There was a problem hiding this comment.
Skimmed. Looks good to me. What you think @HorizonNet ?
| * Use this method filling the backing data source used by {@link #get(RpcController, GetRequest)} | ||
| * @param regionName | ||
| * @param row | ||
| * @param r |
Contributor
There was a problem hiding this comment.
In future, could just purge params that do not have description.
Contributor
There was a problem hiding this comment.
You mean inside test code, right?
HorizonNet
approved these changes
Aug 11, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
Removed all javadoc warnings and now there is no javadoc warning anymore