From 4d8f21d0fb763daa4616687f97d8e607632c429e Mon Sep 17 00:00:00 2001
From: aleigh <a@leigh-co.com>
Date: Mon, 20 Jun 2022 15:05:04 -0700
Subject: [PATCH] lc-eo: Docs

---
 lc-eo/src/main/java/lc/eo/EditTracker.java | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)

diff --git a/lc-eo/src/main/java/lc/eo/EditTracker.java b/lc-eo/src/main/java/lc/eo/EditTracker.java
index 2a5977eae..eed027a5f 100644
--- a/lc-eo/src/main/java/lc/eo/EditTracker.java
+++ b/lc-eo/src/main/java/lc/eo/EditTracker.java
@@ -3,15 +3,24 @@ package lc.eo;
 import java.io.Serializable;
 
 /**
- * Implements edit tracking functionality.
+ * Classes implementing this interface provide edit tracking functionality of some fashion.
  *
  * @author Alex Leigh
  * @since mk10 mod14 (CRYSTAL)
  */
 public interface EditTracker {
+    /**
+     * This method is called by an EO if an attribute value changes.
+     */
     void attributeUpdate(EO eo, String key, Serializable oldValue, Serializable newValue, EOListener listener);
 
-    void loopRemoved(EOLoop loop, EO eo, int index);
+    /**
+     * This method is called by an {@link EOLoop} if an EO is removed from it.
+     */
+    void loopRemoved(EOLoop loop, EO removedEo, int index);
 
-    void loopAdded(EOLoop loop, EO eo);
+    /**
+     * This methid is called by an {@link EOLoop} if an EO is added to it.
+     */
+    void loopAdded(EOLoop loop, EO addedEo);
 }
-- 
GitLab