kdoc

src/main/kotlin/kweb/state/ObservableList.kt

@@ -129,6 +129,12 @@ class ObservableList<ITEM : Any>(
         return items.isEmpty()
     }
 
+    /**
+     * Returns an iterator over the elements in this list (in proper sequence).
+     *
+     * **IMPORTANT:** The returned iterator will throw an UnsupportedOperationException
+     * if you attempt to call [MutableIterator.remove].
+     */
     override fun iterator(): MutableIterator<ITEM> {
         return listIterator()
     }
@@ -170,8 +176,25 @@ class ObservableList<ITEM : Any>(
         }
     }
 
+    /**
+     * Returns a list iterator over the elements in this list (in proper sequence).
+     *
+     * **IMPORTANT:** The returned iterator will throw an UnsupportedOperationException
+     * if you attempt to call [MutableListIterator.add], [MutableListIterator.set], or
+     * [MutableListIterator.remove]. Implementing these in a threadsafe manner is
+     * difficult, and they are not needed for the intended use of this class.
+     */
     override fun listIterator(): MutableListIterator<ITEM> = listIterator(0)
 
+    /**
+     * Returns a list iterator over the elements in this list (in proper sequence),
+     * starting at the specified position.
+     *
+     * **IMPORTANT:** The returned iterator will throw an UnsupportedOperationException
+     * if you attempt to call [MutableListIterator.add], [MutableListIterator.set], or
+     * [MutableListIterator.remove]. Implementing these in a threadsafe manner is
+     * difficult, and they are not needed for the intended use of this class.
+     */
     override fun listIterator(index: Int): MutableListIterator<ITEM> {
         if (closed) {
             throw IllegalStateException("Cannot read closed ObservableList")