javadoc

core/java/src/net/metanotion/util/skiplist/SkipLevels.java

@@ -94,6 +94,13 @@ public class SkipLevels {
 		return bottom.get(key);
 	}
 
+	/**
+	 *  @return An array of two objects or null.
+	 *          rv[0] is the removed object.
+	 *          rv[1] is the deleted SkipLevels if the removed object was the last in the SkipLevels,
+	 *                and the deleted SkipLevels is taller than this SkipLevels.
+	 *          rv is null if no object was removed.
+	 */
 	public Object[] remove(int start, Comparable key, SkipList sl) {
 		Object[] res = null;
 		SkipLevels slvls = null;

core/java/src/net/metanotion/util/skiplist/SkipSpan.java

@@ -225,6 +225,12 @@ public class SkipSpan {
 		}
 	}
 
+	/**
+	 *  @return An array of two objects or null.
+	 *          rv[0] is the removed object.
+	 *          rv[1] is the deleted SkipSpan if the removed object was the last in the SkipSpan.
+	 *          rv is null if no object was removed.
+	 */
 	public Object[] remove(Comparable key, SkipList sl) {
 		if(nKeys == 0) { return null; }
 		if(keys[nKeys - 1].compareTo(key) < 0) {