From 8a0883d4838ad9ce901f9f011a9167c02a2b5017 Mon Sep 17 00:00:00 2001
From: aleigh <a@leigh-co.com>
Date: Mon, 20 Jun 2022 17:18:15 -0700
Subject: [PATCH] lc-eo-changestream: Docs

---
 .../src/main/java/lc/eo/changestream/ChangeSet.java        | 7 +++++++
 .../src/main/java/lc/eo/changestream/ChangeStream.java     | 6 ++++++
 2 files changed, 13 insertions(+)

diff --git a/lc-eo-changestream/src/main/java/lc/eo/changestream/ChangeSet.java b/lc-eo-changestream/src/main/java/lc/eo/changestream/ChangeSet.java
index 1893e0a9f..8091b68ce 100644
--- a/lc-eo-changestream/src/main/java/lc/eo/changestream/ChangeSet.java
+++ b/lc-eo-changestream/src/main/java/lc/eo/changestream/ChangeSet.java
@@ -5,6 +5,13 @@ import lc.eo.EOLoop;
 
 import java.util.HashSet;
 
+/**
+ * This class provides a change set which gathers an atomic set of changes which have occurred in a
+ * {@link ChangeStream}.
+ *
+ * @author C. Alexander Leigh
+ * @since mk1
+ */
 public class ChangeSet {
     private final HashSet<EO> objectsDirty = new HashSet<>();
     private final HashSet<EOLoop> loopsDirty = new HashSet<>();
diff --git a/lc-eo-changestream/src/main/java/lc/eo/changestream/ChangeStream.java b/lc-eo-changestream/src/main/java/lc/eo/changestream/ChangeStream.java
index 771fa77cb..efc3005d4 100644
--- a/lc-eo-changestream/src/main/java/lc/eo/changestream/ChangeStream.java
+++ b/lc-eo-changestream/src/main/java/lc/eo/changestream/ChangeStream.java
@@ -7,6 +7,12 @@ import lc.eo.EditTracker;
 
 import java.io.Serializable;
 
+/**
+ * This class monitors {@link EO} graphs for changes and stores them in {@link ChangeSet} objects.
+ *
+ * @author C. Alexander Leigh
+ * @since mk1
+ */
 public class ChangeStream implements EditTracker {
     private ChangeSet changeSet = new ChangeSet();
 
-- 
GitLab