--- a/doc/models/Makefile Wed Dec 28 14:59:54 2011 +0000
+++ b/doc/models/Makefile Wed Dec 28 16:41:35 2011 -0800
@@ -45,6 +45,7 @@
$(SRC)/wifi/doc/wifi.rst \
$(SRC)/wimax/doc/wimax.rst \
$(SRC)/uan/doc/uan.rst \
+ $(SRC)/topology-read/doc/topology.rst \
$(SRC)/stats/doc/statistics.rst \
$(SRC)/netanim/doc/animation.rst \
$(SRC)/flow-monitor/doc/flow-monitor.rst \
--- a/src/internet/doc/routing-overview.rst Wed Dec 28 14:59:54 2011 +0000
+++ b/src/internet/doc/routing-overview.rst Wed Dec 28 16:41:35 2011 -0800
@@ -6,10 +6,13 @@
|ns3| is intended to support traditional routing approaches and protocols,
support ports of open source routing implementations, and facilitate research
into unorthodox routing techniques. The overall routing architecture is
-described below in :ref:`Routing architecture`. Users who wish to just read
-about how to configure global routing for wired topologies can read :ref:`Global
-centralized routing`. Unicast routing protocols are described in :ref:`Unicast
-routing`. Multicast routing is documented in :ref:`Multicast routing`.
+described below in :ref:`Routing-architecture`. Users who wish to just read
+about how to configure global routing for wired topologies can read
+:ref:`Global-centralized-routing`. Unicast routing protocols are described in
+:ref:`Unicast-routing`. Multicast routing is documented in
+:ref:`Multicast-routing`.
+
+.. _Routing-architecture:
Routing architecture
********************
@@ -72,11 +75,13 @@
Ipv4ListRouting::GetRoutingProtocol()).
The details of these routing protocols are described below in
-:ref:`Unicast routing`. For now, we will first start with a basic
+:ref:`Unicast-routing`. For now, we will first start with a basic
unicast routing capability that is intended to globally build routing
tables at simulation time t=0 for simulation users who do not care
about dynamic routing.
+.. _Global-centralized-routing:
+
Global centralized routing
**************************
@@ -204,6 +209,8 @@
fed into the OSPF shortest path computation logic. The Ipv4 API
is finally used to populate the routes themselves.
+.. _Unicast-routing:
+
Unicast routing
***************
@@ -321,6 +328,8 @@
notifications; i.e. the topology changes are due to loss/gain of connectivity
over a wireless channel.
+.. _Multicast-routing:
+
Multicast routing
*****************
--- a/src/internet/doc/tcp.rst Wed Dec 28 14:59:54 2011 +0000
+++ b/src/internet/doc/tcp.rst Wed Dec 28 16:41:35 2011 -0800
@@ -93,7 +93,7 @@
native |ns3| TCP.
To configure behavior of TCP, a number of parameters are exported through the
-:ref:`Attributes <ns-3 attribute system>`. These are documented in the `Doxygen
+|ns3| attribute system. These are documented in the `Doxygen
<http://www.nsnam.org/doxygen/classns3_1_1_tcp_socket.html>` for class
:cpp:class:`TcpSocket`. For example, the maximum segment size is a
settable attribute.
@@ -137,7 +137,7 @@
Once a TCP socket is created, one will want to follow conventional socket logic
and either connect() and send() (for a TCP client) or bind(), listen(), and
-accept() (for a TCP server). :ref:`Sockets API <Sockets APIs>` for a review of
+accept() (for a TCP server). See :ref:`Sockets-APIs` for a review of
how sockets are used in |ns3|.
Validation
@@ -255,7 +255,7 @@
<http://www.nsnam.org/doxygen/classns3_1_1_tcp_socket.html>`_
Additionally, NSC TCP exports a lot of configuration variables into the
-|ns3| :ref:`Attributes` system, via a `sysctl <http://en.wikipedia.org/wiki/Sysctl>`_-like interface. In the ``examples/tcp/tcp-nsc-zoo`` example, you
+|ns3| attributes system, via a `sysctl <http://en.wikipedia.org/wiki/Sysctl>`_-like interface. In the ``examples/tcp/tcp-nsc-zoo`` example, you
can see the following configuration:::
--- a/src/network/doc/sockets-api.rst Wed Dec 28 14:59:54 2011 +0000
+++ b/src/network/doc/sockets-api.rst Wed Dec 28 16:41:35 2011 -0800
@@ -1,5 +1,7 @@
.. include:: replace.txt
+.. _Sockets-APIs:
+
Sockets APIs
------------
--- a/src/propagation/doc/propagation.rst Wed Dec 28 14:59:54 2011 +0000
+++ b/src/propagation/doc/propagation.rst Wed Dec 28 16:41:35 2011 -0800
@@ -1,5 +1,7 @@
.. include:: replace.txt
+.. _Propagation:
+
Propagation
-----------
--- a/src/wifi/doc/wifi.rst Wed Dec 28 14:59:54 2011 +0000
+++ b/src/wifi/doc/wifi.rst Wed Dec 28 16:41:35 2011 -0800
@@ -158,8 +158,8 @@
an actual simulation object. In |ns3|, helper objects (used at the helper API
only) are created on the stack (they could also be created with operator new and
later deleted). However, the actual |ns3| objects typically inherit from
-``class ns3::Object`` and are assigned to a smart pointer. See the chapter on
-:ref:`Object model` for a discussion of the |ns3| object model, if you are not
+``class ns3::Object`` and are assigned to a smart pointer. See the chapter in
+the |ns3| manual for a discussion of the |ns3| object model, if you are not
familiar with it.
*Todo: Add notes about how to configure attributes with this helper API*
@@ -243,7 +243,7 @@
This creates the WifiNetDevice which includes also a WifiRemoteStationManager, a
WifiMac, and a WifiPhy (connected to the matching WifiChannel).
-There are many |ns3| :ref:`Attributes` that can be set on the above helpers to
+There are many |ns3| attributes that can be set on the above helpers to
deviate from the default behavior; the example scripts show how to do some of
this reconfiguration.
@@ -268,7 +268,7 @@
The WifiChannel subclass can be used to connect together a set of
``ns3::WifiNetDevice`` network interfaces. The class ``ns3::WifiPhy`` is the
object within the WifiNetDevice that receives bits from the channel.
-For the channel propagation modeling, the propagation module is used; see section :ref:`propagation` for details.
+For the channel propagation modeling, the propagation module is used; see section :ref:`Propagation` for details.
This section summarizes the description of the BER calculations found in the
--- a/src/wimax/doc/wimax.rst Wed Dec 28 14:59:54 2011 +0000
+++ b/src/wimax/doc/wimax.rst Wed Dec 28 16:41:35 2011 -0800
@@ -152,7 +152,7 @@
Wimax Attributes
****************
-The WimaxNetDevice makes heavy use of the |ns3| :ref:`Attributes` subsystem for
+The WimaxNetDevice makes heavy use of the |ns3| attributes subsystem for
configuration and default value management. Presently, approximately 60 values
are stored in this system.
@@ -213,6 +213,8 @@
.. _wimax-architecture:
.. figure:: figures/WimaxArchitecture.*
+
+ WiMAX architecture
Convergence Sublayer
++++++++++++++++++++