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/core/time | |
| 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/core/time')
| -rw-r--r-- | src/main/java/core/time/VSTime.java | 19 |
1 files changed, 14 insertions, 5 deletions
diff --git a/src/main/java/core/time/VSTime.java b/src/main/java/core/time/VSTime.java index d46e0e4..20806d6 100644 --- a/src/main/java/core/time/VSTime.java +++ b/src/main/java/core/time/VSTime.java @@ -1,22 +1,31 @@ package core.time; /** - * This interface is a guidline for general time format classes. + * Interface for time representations in the distributed simulator. + * This interface provides a common contract for different time implementations + * including Lamport logical time and vector clocks. + * + * <p>All time implementations must track the global simulation time + * and provide a string representation for display purposes.</p> * + * @see VSLamportTime + * @see VSVectorTime * @author Paul C. Buetow */ public interface VSTime { /** - * Gets the global time. + * Gets the global simulation time when this time value was recorded. + * This allows correlation between logical time and simulation time. * - * @return The global time + * @return the global simulation time in milliseconds */ public long getGlobalTime(); /** - * Returns a string representation. + * Returns a string representation of this time value. + * The format depends on the specific time implementation. * - * @return The representation of the implementing object as a string + * @return string representation suitable for display or logging */ public String toString(); } |
