add a javadoc comment on VIntCoding function

2018-07-17 22:23:06 -07:00 · 2018-07-17 22:23:06 -07:00 · 8bc2fba3e5
parent 207c80c1fd
commit 8bc2fba3e5
1 changed files with 2 additions and 0 deletions
--- a/src/java/org/apache/cassandra/utils/vint/VIntCoding.java
+++ b/src/java/org/apache/cassandra/utils/vint/VIntCoding.java
@ -86,6 +86,8 @@ public class VIntCoding
     * Note this method is the same as {@link #readUnsignedVInt(DataInput)},
     * except that we do *not* block if there are not enough bytes in the buffer
     * to reconstruct the value.
+     *
+     * @return -1 if there are not enough bytes in the input to read the value; else, the vint unsigned value.
     */
    public static long readUnsignedVInt(ByteBuf input)
    {