core: (documentation) fix stale code sample

This commit is contained in:
Tom Henderson
2016-02-01 14:52:17 -08:00
parent aa1307e844
commit e45db80b8b

View File

@@ -35,10 +35,13 @@ namespace ns3 {
* @brief Class used for synchronizing the simulation events to a real-time
* "wall clock" using Posix clock functions.
*
* Enable this synchronizer using:
* This synchronizer is used as part of the RealtimeSimulatorImpl. It is
* typically not explicitly enabled by users but instead is implicitly
* enabled when the simulator implementation type is set to real-time; e.g.:
*
* @code
* DefaultValue::Bind ("Synchronizer", "WallClockSynchronizer");
* GlobalValue::Bind ("SimulatorImplementationType",
* StringValue ("ns3::RealtimeSimulatorImpl"));
* @endcode
*
* before calling any simulator functions.