Skip to content

Commit 70e6250

Browse files
committed
doc: various fixes to eliminate sphinx warnings
1 parent 4c583f9 commit 70e6250

9 files changed

Lines changed: 14 additions & 14 deletions

File tree

doc/src/developers-guide/ch-mobility.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ component has to prevent the node from exiting. It can call the
3333
torus, random placement, and error.
3434

3535
MovingMobilityBase class
36-
~~~~~~~~~~~~~~~~~~
36+
~~~~~~~~~~~~~~~~~~~~~~~~
3737

3838
The abstract :cpp:`MovingMobilityBase` class can be used to model mobilities
3939
when the node moves on a continuous trajectory and updates its position

doc/src/developers-guide/ch-tags.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ enqueued/dequeued, encapsulated/decapsulated, cloned, buffered, or stored for la
7676
the tags remain unchanged.
7777

7878
Specifying the Protocol of a Packet
79-
----------------------------------
79+
-----------------------------------
8080

8181
The most important packet tag is the :cpp:`PacketProtocolTag`. It specifies the
8282
outermost protocol of the packet. This tag should always be present because the
@@ -101,7 +101,7 @@ the packet protocol tag can only specify the inner protocol that is being encaps
101101
into an Ethernet MAC frame.
102102

103103
Dispatching Packets to Protocol Modules
104-
--------------------------------------
104+
---------------------------------------
105105

106106
Inside a network node, protocol modules interact with one another by sending
107107
:cpp:`Packet` or :cpp:`Message` objects. INET provides great flexibility in terms

doc/src/users-guide/ch-apps.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -387,7 +387,7 @@ this can be zero (zero is not allowed for :par:`sendInterval`). The zero
387387
:par:`burstDuration` is interpreted as infinity.
388388

389389
Operation as a sink
390-
^^^^^^^^^^^^^^^^^^
390+
^^^^^^^^^^^^^^^^^^^
391391

392392
When the :par:`destAddresses` parameter is empty, the module receives
393393
packets and makes statistics only.

showcases/emulation/babel/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ This can be worked around with ``nsenter``, as will be shown later. Here is the
175175
:end-at: unshare-
176176

177177
The :ned:`ExternalEnvironment` module deals with preparing the host OS environment
178-
for running the emulation, then cleaning up afterwards. Specifically, the module's :par:`setupCommand` is executed at module creation, and :ned:`teardownCommand` at module destruction.
178+
for running the emulation, then cleaning up afterwards. Specifically, the module's :par:`setupCommand` is executed at module creation, and :par:`teardownCommand` at module destruction.
179179
We use these parameters to create and destroy network namespaces and virtual network interfaces in the host OS for each network node.
180180
We include an :ned:`ExternalEnvironment` module in hosts by setting the :par:`hasEnvironment` parameter to ``true``:
181181

showcases/emulation/voip/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ This section presents various configurations for running the VoIP simulation.
154154
It includes a setup for running the experiment over a real network, and
155155
various configurations for running it in a virtual network on the local computer.
156156

157-
.. note:: A different showcase (:doc:`mininet`) is dedicated to showing the use of
157+
.. note:: A different showcase (:doc:`/showcases/emulation/mininet/doc/index`) is dedicated to showing the use of
158158
Mininet for setting up the virtual network.
159159

160160
Over a Real Network

showcases/general/pcaprecording/doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ PCAP recorder modules, because ``router1`` has two interfaces.
161161
.. literalinclude:: ../omnetpp.ini
162162
:language: ini
163163
:start-at: router1.numPcapRecorders
164-
:end-before: moduleNamePatterns = "eth[*]
164+
:end-at: moduleNamePatterns = "eth[0]
165165

166166
In ``router2``, we'll record only packets carrying TCP data on the ``eth0``
167167
interface. ``router2`` has two interfaces, so the :par:`moduleNamePatters`

showcases/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ the simulations (NED, ini, and other files) and the web pages are in the
1818
1919
Latest changes:
2020

21-
- :doc:`emulation/voip/doc/mininet` added (2024-02-26)
21+
- :doc:`emulation/mininet/doc/index` added (2024-02-26)
2222
- :doc:`tsn/trafficshaping/underthehood/doc/index` updated (2023-07-28)
2323
- :doc:`tsn/trafficshaping/cbsandtas/doc/index` released (2023-07-28)
2424
- :doc:`tsn/trafficshaping/cbsandats/doc/index` updated (2023-07-28)

showcases/visualizer/canvas/spectrum/doc/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,8 +121,8 @@ shape in frequency (the spectral mask in the 802.11 standard):
121121
:align: center
122122

123123
.. literalinclude:: ../omnetpp.ini
124-
:start-at: radio.typename
125-
:end-at: transmitter.frequencyGains
124+
:start-at: radio.signalAnalogRepresentation
125+
:end-at: transmitter.analogModel.frequencyGains
126126
:language: ini
127127

128128
.. note:: We're using linear interpolation instead of log-linear when defining the signal

showcases/visualizer/canvas/transportpathactivity/doc/index.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ In this simulation, the ``pathVisualizer's`` type is
6767
:par:`displayRoutes` parameter to true.
6868

6969
.. literalinclude:: ../omnetpp.ini
70-
:start-at: pathVisualizer.*.displayRoutes
71-
:end-at: pathVisualizer.*.displayRoutes
70+
:start-at: pathVisualizer.displayRoutes
71+
:end-at: pathVisualizer.displayRoutes
7272
:language: ini
7373

7474
The following video shows what happens when the simulation is run.
@@ -146,8 +146,8 @@ does not fade out completely before the next ``UDPBasicAppData`` packet
146146
arrives.
147147

148148
.. literalinclude:: ../omnetpp.ini
149-
:start-at: TransportRouteCanvasVisualizer.displayRoutes
150-
:end-at: TransportRouteCanvasVisualizer.packetFilter
149+
:start-at: transportRouteVisualizer.displayRoutes
150+
:end-at: transportRouteVisualizer.packetFilter
151151
:language: ini
152152

153153
The following video has been captured from the simulation and shows

0 commit comments

Comments
 (0)