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/simulator/VSSimulator.java | 21 +++++++++++++++++----
 1 file changed, 17 insertions(+), 4 deletions(-)

(limited to 'src/main/java/simulator/VSSimulator.java')

diff --git a/src/main/java/simulator/VSSimulator.java b/src/main/java/simulator/VSSimulator.java
index 4515357..c6bdfad 100644
--- a/src/main/java/simulator/VSSimulator.java
+++ b/src/main/java/simulator/VSSimulator.java
@@ -55,10 +55,23 @@ import serialize.VSSerializable;
 import serialize.VSSerialize;
 
 /**
- * The class VSSimulator, an object of this class represents a whole simulator.
- * It may be, that several parallel simulators exist. They are independent
- * fron each other.
- *
+ * Main simulator control panel and coordinator for the distributed systems simulator.
+ * This class manages the simulation UI and coordinates between various components:
+ * <ul>
+ *   <li>Process management and visualization</li>
+ *   <li>Task scheduling and execution</li>
+ *   <li>Event and protocol management</li>
+ *   <li>Logging and filtering</li>
+ *   <li>Simulation control (play, pause, reset)</li>
+ * </ul>
+ * 
+ * <p>The simulator provides both a graphical interface for controlling the
+ * simulation and programmatic access to simulation state. Multiple independent
+ * simulators can exist in parallel without interfering with each other.</p>
+ * 
+ * @see VSSimulatorVisualization
+ * @see VSTaskManager
+ * @see VSInternalProcess
  * @author Paul C. Buetow
  */
 public class VSSimulator extends JPanel implements VSSerializable {
-- 
cgit v1.2.3