src/simulator/simulator.h
changeset 123 1a3cdef3218d
parent 122 6b8f1eda5c57
child 131 f4fb87e77034
--- a/src/simulator/simulator.h	Fri Oct 06 13:37:25 2006 +0200
+++ b/src/simulator/simulator.h	Fri Oct 06 20:17:53 2006 +0200
@@ -304,6 +304,9 @@
      * Note that it is not possible to test for the expiration of
      * events which were scheduled for the "destroy" time. Doing so
      * will result in a program error (crash).
+     * An event is said to "expire" when it starts being scheduled
+     * which means that if the code executed by the event calls
+     * this function, it will get true.
      *
      * @param id the event to test for expiration
      * @returns true if the event has expired, false otherwise.