1 files changed, 6 insertions, 0 deletions

diff --git a/opendc-core/src/main/kotlin/com/atlarge/opendc/simulator/kernel/Simulation.kt b/opendc-core/src/main/kotlin/com/atlarge/opendc/simulator/kernel/Simulation.kt
index 0954868a..14ce5a1a 100644
--- a/opendc-core/src/main/kotlin/com/atlarge/opendc/simulator/kernel/Simulation.kt
+++ b/opendc-core/src/main/kotlin/com/atlarge/opendc/simulator/kernel/Simulation.kt
@@ -63,12 +63,16 @@ interface Simulation<M> {
     /**
      * Step through one cycle in the simulation. This method will process all events in a single tick, update the
      * internal clock and then return the control to the user.
+     *
+     * This method will throw if a process running during the cycle throws an exception.
      */
     fun step()
 
     /**
      * Run a simulation over the specified model.
      * This method will step through multiple cycles in the simulation until no more message exist in the queue.
+     *
+     * This method will throw if a process running during a cycle throws an exception.
      */
     fun run()
 
@@ -76,6 +80,8 @@ interface Simulation<M> {
      * Run a simulation over the specified model, stepping through cycles until the specified clock tick has
      * occurred. The control is then handed back to the user.
      *
+     * This method will throw if a process running during a cycle throws an exception.
+     *
      * @param until The point in simulation time at which the simulation should be paused and the control is handed
      * 				back to the user.
      */