saintstack commented on a change in pull request #302: HBASE-22571 Javadoc
Warnings related to @return tag
URL: https://github.com/apache/hbase/pull/302#discussion_r299225915
##########
File path:
hbase-client/src/main/java/org/apache/hadoop/hbase/client/SimpleRequestController.java
##########
@@ -433,7 +433,7 @@ private void waitForRegion() throws InterruptedIOException
{
*
* @param loc
* @param heapSizeOfRow
- * @return
+ * @return either Include {@link ReturnCode} or Skip {@link ReturnCode}
Review comment:
Another option if the parameter or return code are self-explanatory is to
just remove them from javadoc. Perhaps not here but in the below where you add
the text 'the row key' as description on a param named 'key'...
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
