more dox improvements
authorMathieu Lacage <mathieu.lacage@sophia.inria.fr>
Thu, 24 May 2007 09:22:48 +0200
changeset 682 d876b6dfb32e
parent 681 e1696c31b6eb
child 683 12f6158f0bc8
more dox improvements
src/simulator/nstime.h
src/simulator/simulator.h
--- a/src/simulator/nstime.h	Thu May 24 09:18:42 2007 +0200
+++ b/src/simulator/nstime.h	Thu May 24 09:22:48 2007 +0200
@@ -448,7 +448,9 @@
  *
  * This is an instance of type ns3::TimeUnit<1>: it is
  * the return value of the ns3::Simulator::Now method
- * and is needed for the Simulator::Schedule methods
+ * and is needed for the Simulator::Schedule methods.
+ * The precision of the underlying Time unit can be
+ * changed with calls to TimeStepPrecision::Set.
  *
  * Time instances can be created through any of the following functions:
  *  - ns3::Seconds
--- a/src/simulator/simulator.h	Thu May 24 09:18:42 2007 +0200
+++ b/src/simulator/simulator.h	Thu May 24 09:22:48 2007 +0200
@@ -37,11 +37,13 @@
  * \brief Control the scheduling of simulation events. 
  *
  * The internal simulation clock is maintained
- * as a 64-bit integer in nanosecond units. This means that it is
+ * as a 64-bit integer in a unit specified by the user
+ * through the TimeStepPrecision::Set function. This means that it is
  * not possible to specify event expiration times with anything better
- * than nanosecond accuracy. Events whose expiration time is
- * the same are scheduled in FIFO order: the first event inserted in the
- * Scheduling queue is scheduled to expire first.
+ * than this user-specified accuracy. Events whose expiration time is
+ * the same modulo this accuracy are scheduled in FIFO order: the 
+ * first event inserted in the scheduling queue is scheduled to 
+ * expire first.
  * 
  * A simple example of how to use the Simulator class to schedule events
  * is shown below: