Repair Time docs mangled by f0be2daaa38f
This commit is contained in:
@@ -34,52 +34,6 @@ namespace ns3 {
|
||||
* \ingroup core
|
||||
* \defgroup time Time
|
||||
*/
|
||||
/**
|
||||
* \ingroup time
|
||||
* \brief keep track of time unit.
|
||||
*
|
||||
* This template class is used to keep track of the value
|
||||
* of a specific time unit: the type TimeUnit<1> is used to
|
||||
* keep track of seconds, the type TimeUnit<2> is used to keep
|
||||
* track of seconds squared, the type TimeUnit<-1> is used to
|
||||
* keep track of 1/seconds, etc.
|
||||
*
|
||||
* This base class defines all the functionality shared by all
|
||||
* these time unit objects: it defines all the classic arithmetic
|
||||
* operators +, -, *, /, and all the classic comparison operators:
|
||||
* ==, !=, <, >, <=, >=. It is thus easy to add, substract, or
|
||||
* multiply multiple TimeUnit objects. The return type of any such
|
||||
* arithmetic expression is always a TimeUnit object.
|
||||
*
|
||||
* The ns3::uint64_t, ns3::Time, ns3::TimeSquare, and ns3::TimeInvert classes
|
||||
* are aliases for the TimeUnit<0>, TimeUnit<1>, TimeUnit<2> and TimeUnit<-1>
|
||||
* types respectively.
|
||||
*
|
||||
* For example:
|
||||
* \code
|
||||
* Time<1> t1 = Seconds (10.0);
|
||||
* Time<1> t2 = Seconds (10.0);
|
||||
* Time<2> t3 = t1 * t2;
|
||||
* Time<0> t4 = t1 / t2;
|
||||
* Time<3> t5 = t3 * t1;
|
||||
* Time<-2> t6 = t1 / t5;
|
||||
* TimeSquare t7 = t3;
|
||||
* uint64_t s = t4;
|
||||
* \endcode
|
||||
*
|
||||
* If you try to assign the result of an expression which does not
|
||||
* match the type of the variable it is assigned to, you will get a
|
||||
* compiler error. For example, the following will not compile:
|
||||
* \code
|
||||
* Time<1> = Seconds (10.0) * Seconds (1.5);
|
||||
* \endcode
|
||||
*
|
||||
* You can also use the following non-member functions to manipulate
|
||||
* any of these ns3::TimeUnit object:
|
||||
* - \ref ns3-Time-Abs ns3::Abs
|
||||
* - \ref ns3-Time-Max ns3::Max
|
||||
* - \ref ns3-Time-Min ns3::Min
|
||||
*/
|
||||
/**
|
||||
* \ingroup time
|
||||
* \brief keep track of time values and allow control of global simulation resolution
|
||||
@@ -87,10 +41,7 @@ namespace ns3 {
|
||||
* This class defines all the classic C++ arithmetic
|
||||
* operators +, -, *, /, and all the classic comparison operators:
|
||||
* ==, !=, <, >, <=, >=. It is thus easy to add, substract, or
|
||||
* multiply multiple Time objects.
|
||||
*
|
||||
* The ns3::uint64_t, ns3::TimeSquare, and ns3::TimeInvert classes
|
||||
* are backward-compatibility aliases for ns3::Time.
|
||||
* multiply Time objects.
|
||||
*
|
||||
* For example:
|
||||
* \code
|
||||
|
||||
Reference in New Issue
Block a user