Update manual with Start/DoStart to Initialize/DoInitialize change
authorVedran Miletić <rivanvx@gmail.com>
Sat, 20 Apr 2013 00:39:11 +0200
changeset 9707 123864f4f6ed
parent 9706 f5e3b185f047
child 9708 443bde2aa701
Update manual with Start/DoStart to Initialize/DoInitialize change
doc/manual/source/events.rst
--- a/doc/manual/source/events.rst	Sat Apr 20 00:36:39 2013 +0200
+++ b/doc/manual/source/events.rst	Sat Apr 20 00:39:11 2013 +0200
@@ -153,11 +153,11 @@
 how the context (node id) of the first event is set to that of its
 associated node. This is accomplished by the NodeList class: whenever a
 new node is created, the NodeList class uses ScheduleWithContext to
-schedule a 'start' event for this node. The 'start' event thus executes
+schedule a 'initialize' event for this node. The 'initialize' event thus executes
 with a context set to that of the node id and can use the normal variety
-of Schedule methods. It invokes the Node::Start method which propagates
-the 'start' event by calling the DoStart method for each object
-associated with the node. The DoStart method overridden in some of these
+of Schedule methods. It invokes the Node::Initialize method which propagates
+the 'initialize' event by calling the DoInitialize method for each object
+associated with the node. The DoInitialize method overridden in some of these
 objects (most notably in the Application base class) will schedule some
 events (most notably Application::StartApplication) which will in turn
 scheduling traffic generation events which will in turn schedule
@@ -165,8 +165,8 @@
 
 Notes:
 
-* Users need to be careful to propagate DoStart methods across objects
-  by calling Start explicitely on their member objects
+* Users need to be careful to propagate DoInitialize methods across objects
+  by calling Initialize explicitely on their member objects
 * The context id associated with each ScheduleWithContext method has
   other uses beyond logging: it is used by an experimental branch of ns-3
   to perform parallel simulation on multicore systems using