HorizonNet commented on a change in pull request #322: HBASE-22586 Javadoc
Warnings related to @param tag
URL: https://github.com/apache/hbase/pull/322#discussion_r300321468
##########
File path:
hbase-common/src/main/java/org/apache/hadoop/hbase/PrivateCellUtil.java
##########
@@ -2605,8 +2605,12 @@ public static final int compare(CellComparator
comparator, Cell left, byte[] key
* method is used both in the normal comparator and the "same-prefix"
comparator. Note that we are
* assuming that row portions of both KVs have already been parsed and found
identical, and we
* don't validate that assumption here.
- * @param commonPrefix the length of the common prefix of the two key-values
being compared,
- * including row length and row
+ * @param comparator the {@link CellComparator}} to use for comparison
+ * @param left the cell to be compared
+ * @param right the serialized key part of a key-value
+ * @param roffset the offset in the key byte[]
+ * @param rlength the length of the key byte[]
+ * @param rowlength the row length
*/
static final int compareWithoutRow(CellComparator comparator, Cell left,
byte[] right,
Review comment:
Because you're already on it, could you please also document the return
value?
----------------------------------------------------------------
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
