From 7ee77637273e2e913cf19f078e9143ae6977f44f Mon Sep 17 00:00:00 2001
From: Paul Buetow <paul@buetow.org>
Date: Fri, 20 Jun 2025 19:25:10 +0300
Subject: Add comprehensive Javadoc documentation for public APIs
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

- Document core classes: VSTask, VSMessage, VSInternalProcess
- Document event interfaces: VSAbstractEvent, VSCopyableEvent, VSTime
- Document timestamp events: VSTimestampTriggeredEvent, VSLamportTimestampEvent
- Document protocol framework: VSAbstractProtocol methods
- Document VSSimulator and VSRegisteredEvents
- Add detailed method descriptions with parameter and return value docs
- Include usage examples and cross-references between related classes

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
---
 src/main/java/events/VSCopyableEvent.java | 23 +++++++++++++++++++----
 1 file changed, 19 insertions(+), 4 deletions(-)

(limited to 'src/main/java/events/VSCopyableEvent.java')

diff --git a/src/main/java/events/VSCopyableEvent.java b/src/main/java/events/VSCopyableEvent.java
index 23125ce..0b93f9e 100644
--- a/src/main/java/events/VSCopyableEvent.java
+++ b/src/main/java/events/VSCopyableEvent.java
@@ -1,16 +1,31 @@
 package events;
 
 /**
- * The interface VSCopyableEvent, all events which implement this class
- * are copyable.
+ * Interface for events that support copying.
+ * Events that implement this interface can be duplicated, which is useful
+ * for creating multiple instances of the same event or for event scheduling.
+ * 
+ * <p>To make an event copyable:</p>
+ * <ol>
+ *   <li>Implement this interface</li>
+ *   <li>Override initCopy() to copy all event-specific state</li>
+ *   <li>The framework will handle creating the new instance</li>
+ * </ol>
+ * 
+ * <p>Events that don't implement this interface will throw
+ * {@link exceptions.VSEventNotCopyableException} when copy is attempted.</p>
  *
+ * @see VSAbstractEvent#getCopy()
+ * @see exceptions.VSEventNotCopyableException
  * @author Paul C. Buetow
  */
 public interface VSCopyableEvent {
     /**
-     * Fills a copy of this event with its values
+     * Initializes a copy of this event with all necessary state.
+     * This method should copy all event-specific fields to the provided copy.
+     * The copy will already be initialized with the same process and basic properties.
      *
-     * @param copy The copy
+     * @param copy the event instance to initialize with this event's state
      */
     public void initCopy(VSAbstractEvent copy);
 }
-- 
cgit v1.2.3