From ccda4f247aefa6bb2ffddb1d87a7590584771f2d Mon Sep 17 00:00:00 2001 From: Mitch Watrous Date: Fri, 6 May 2011 08:38:41 -0700 Subject: [PATCH] Fix module names in documentation --- doc/manual/source/routing.rst | 2 +- doc/tutorial/source/building-topologies.rst | 20 ++++++++++++-------- doc/tutorial/source/conceptual-overview.rst | 7 ++++--- doc/tutorial/source/introduction.rst | 1 - doc/tutorial/source/tracing.rst | 8 ++++---- 5 files changed, 21 insertions(+), 17 deletions(-) diff --git a/doc/manual/source/routing.rst b/doc/manual/source/routing.rst index 22f1ea1b1..b0344bbb2 100644 --- a/doc/manual/source/routing.rst +++ b/doc/manual/source/routing.rst @@ -107,7 +107,7 @@ Global Unicast Routing API The public API is very minimal. User scripts include the following::: - #include "ns3/helper-module.h" + #include "ns3/internet-module.h" If the default InternetStackHelper is used, then an instance of global routing will be aggregated to each node. After IP addresses are configured, the diff --git a/doc/tutorial/source/building-topologies.rst b/doc/tutorial/source/building-topologies.rst index 71b8d4275..3c4666f99 100644 --- a/doc/tutorial/source/building-topologies.rst +++ b/doc/tutorial/source/building-topologies.rst @@ -38,9 +38,12 @@ The actual code begins by loading module include files just as was done in the :: #include "ns3/core-module.h" - #include "ns3/simulator-module.h" - #include "ns3/node-module.h" - #include "ns3/helper-module.h" + #include "ns3/network-module.h" + #include "ns3/csma-module.h" + #include "ns3/internet-module.h" + #include "ns3/point-to-point-module.h" + #include "ns3/applications-module.h" + #include "ns3/ipv4-global-routing-helper.h" One thing that can be surprisingly useful is a small bit of ASCII art that shows a cartoon of the network topology constructed in the example. You will @@ -805,11 +808,12 @@ to the Wifi module and the mobility module which we will discuss below. :: #include "ns3/core-module.h" -#include "ns3/simulator-module.h" -#include "ns3/node-module.h" -#include "ns3/helper-module.h" -#include "ns3/wifi-module.h" -#include "ns3/mobility-module.h" +#include "ns3/network-module.h" +#include "ns3/csma-module.h" +#include "ns3/internet-module.h" +#include "ns3/point-to-point-module.h" +#include "ns3/applications-module.h" +#include "ns3/ipv4-global-routing-helper.h" The network topology illustration follows: diff --git a/doc/tutorial/source/conceptual-overview.rst b/doc/tutorial/source/conceptual-overview.rst index a1cb165c6..33fd311d5 100644 --- a/doc/tutorial/source/conceptual-overview.rst +++ b/doc/tutorial/source/conceptual-overview.rst @@ -220,9 +220,10 @@ The code proper starts with a number of include statements. :: #include "ns3/core-module.h" - #include "ns3/simulator-module.h" - #include "ns3/node-module.h" - #include "ns3/helper-module.h" + #include "ns3/network-module.h" + #include "ns3/internet-module.h" + #include "ns3/point-to-point-module.h" + #include "ns3/applications-module.h" To help our high-level script users deal with the large number of include files present in the system, we group includes according to relatively large diff --git a/doc/tutorial/source/introduction.rst b/doc/tutorial/source/introduction.rst index 1b489a01a..2094ffef4 100644 --- a/doc/tutorial/source/introduction.rst +++ b/doc/tutorial/source/introduction.rst @@ -96,7 +96,6 @@ contribute to |ns3| like they have for ns-2: `_ page, similar to ns-2's popular Contributed Code `page `_; -* ``src/contrib`` directory (we will host your contributed code); * Open `bug tracker `_; * |ns3| developers will gladly help potential contributors to get diff --git a/doc/tutorial/source/tracing.rst b/doc/tutorial/source/tracing.rst index fa1d52400..66ea09119 100644 --- a/doc/tutorial/source/tracing.rst +++ b/doc/tutorial/source/tracing.rst @@ -1339,10 +1339,10 @@ favorite editor. You should see some familiar looking code: #include #include "ns3/core-module.h" - #include "ns3/common-module.h" - #include "ns3/simulator-module.h" - #include "ns3/node-module.h" - #include "ns3/helper-module.h" + #include "ns3/network-module.h" + #include "ns3/internet-module.h" + #include "ns3/point-to-point-module.h" + #include "ns3/applications-module.h" using namespace ns3;