diff options
| author | Paul Buetow <paul@buetow.org> | 2025-06-20 19:25:10 +0300 |
|---|---|---|
| committer | Paul Buetow <paul@buetow.org> | 2025-06-20 19:25:10 +0300 |
| commit | 7ee77637273e2e913cf19f078e9143ae6977f44f (patch) | |
| tree | 2cda0f82a7bf4c6f76e115f57e28de18d744d5e6 /src/main/java/simulator/VSSimulator.java | |
| parent | 70fc0505b223f7bf17d3671d0532773359cf7858 (diff) | |
Add comprehensive Javadoc documentation for public APIs
- 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>
Diffstat (limited to 'src/main/java/simulator/VSSimulator.java')
| -rw-r--r-- | src/main/java/simulator/VSSimulator.java | 21 |
1 files changed, 17 insertions, 4 deletions
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 { |
