doc: Fix various documentation formatting warnings

This commit is contained in:
Tom Henderson
2023-07-06 12:21:53 -07:00
parent 0d00070a73
commit 79e3e8453b
9 changed files with 25 additions and 24 deletions

View File

@@ -19,7 +19,7 @@ either WSL or the Msys2/MinGW64 toolchain (installing both is not required).
.. note::
|ns3| is not fully compatible with Visual Studio IDE / MSVC compiler; only Visual Studio Code
editor, the Msys2/MinGW64 toolchain, and WSL, as explained below.
editor, the Msys2/MinGW64 toolchain, and WSL, as explained below.
.. _WSL2:

View File

@@ -78,7 +78,6 @@ SOURCEFIGS = \
figures/hotspot-top-down.png \
figures/perfetto-trace-cmake.png \
figures/uprof-collect-callstack.png \
figures/uprof-collect-callstack.png \
figures/uprof-profile-application.png \
figures/uprof-select-events.png \
figures/uprof-start.png \

View File

@@ -33,7 +33,7 @@ search for specific information.
To run it, simply open terminal and type
.. sourcecode::
.. sourcecode:: bash
$ ./ns3 run print-introspected-doxygen
@@ -78,7 +78,7 @@ This tool is used to benchmark the scheduler algorithms used in |ns3|.
Command-line Arguments
++++++++++++++++++++++
.. sourcecode::
.. sourcecode:: bash
$ ./ns3 run "bench-scheduler --help"
bench-scheduler [Program Options] [General Arguments]
@@ -129,7 +129,7 @@ Invocation
To run it, simply open the terminal and type
.. sourcecode::
.. sourcecode:: bash
$ ./ns3 run bench-scheduler -- --runs=5
@@ -156,7 +156,7 @@ It will show something like this depending upon the scheduler being benchmarked:
Suppose we had to benchmark `CalendarScheduler` instead, we would have written
.. sourcecode::
.. sourcecode:: bash
$ ./ns3 run bench-scheduler -- --runs=5 --cal"

View File

@@ -1463,8 +1463,8 @@ This should also be self-explanatory.
Previous versions of |ns3| declared a custom application called ``MyApp``
for use in this program. Current versions of |ns3| have moved this to
a separate header file (``tutorial-app.h'') and implementation file
(``tutorial-app.cc''). This simple application allows the ``Socket''
a separate header file (``tutorial-app.h``) and implementation file
(``tutorial-app.cc``). This simple application allows the ``Socket``
to be created at configuration time.
::
@@ -1887,11 +1887,11 @@ Main Program
~~~~~~~~~~~~
The main function starts off by configuring the TCP type to use a legacy
``NewReno`` congestion control variant, with what is called the ``classic''
``NewReno`` congestion control variant, with what is called the ``classic``
TCP loss recovery mechanism. When this tutorial program was originally
written, these were the default TCP configurations, but over time,
|ns3| TCP has evolved to use the current Linux TCP defaults of ``Cubic``
and ``Prr'' loss recovery. The first statements also configure the
and ``Prr`` loss recovery. The first statements also configure the
command-line argument processing.
::