src/simulator/event-id.h
changeset 70 fcd8da09ef75
parent 54 f860e6f94787
child 110 9ac6d63bfe33
--- a/src/simulator/event-id.h	Wed Sep 06 14:35:40 2006 +0200
+++ b/src/simulator/event-id.h	Wed Sep 06 14:46:09 2006 +0200
@@ -27,11 +27,23 @@
 
 class EventImpl;
 
+/**
+ * \brief an identifier for simulation events.
+ */
 class EventId {
 public:
     EventId ();
     EventId (EventImpl *impl, uint64_t ns, uint32_t uid);
+	/**
+	 * This method is syntactic sugar for the ns3::Simulator::cancel
+	 * method.
+	 */
     void cancel (void);
+	/**
+	 * This method is syntactic sugar for the ns3::Simulator::isExpired
+	 * method.
+	 * \returns true if the event has expired, false otherwise.
+	 */
     bool isExpired (void);
 public:
     /* The following methods are semi-private