From a7fceb644fe94bb50a02ea6c90efeb24a379cada Mon Sep 17 00:00:00 2001
From: zzz <zzz@mail.i2p>
Date: Sat, 26 Mar 2011 05:50:13 +0000
Subject: [PATCH] javadoc

---
 core/java/src/net/metanotion/util/skiplist/SkipLevels.java | 7 +++++++
 core/java/src/net/metanotion/util/skiplist/SkipSpan.java   | 6 ++++++
 2 files changed, 13 insertions(+)

diff --git a/core/java/src/net/metanotion/util/skiplist/SkipLevels.java b/core/java/src/net/metanotion/util/skiplist/SkipLevels.java
index d5b12e690..582d6fd3f 100644
--- a/core/java/src/net/metanotion/util/skiplist/SkipLevels.java
+++ b/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;
diff --git a/core/java/src/net/metanotion/util/skiplist/SkipSpan.java b/core/java/src/net/metanotion/util/skiplist/SkipSpan.java
index 8cc5883c1..5f4a3cbdc 100644
--- a/core/java/src/net/metanotion/util/skiplist/SkipSpan.java
+++ b/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) {