From e051eec606ad615a8060d788a901f5887d460ace Mon Sep 17 00:00:00 2001
From: "Dennis.Glaeser" <dennis.glaeser@iws.uni-stuttgart.de>
Date: Thu, 2 Apr 2020 11:35:47 +0200
Subject: [PATCH] [examples][1ptracer] add tables of contents

---
 examples/1ptracer/doc/1pintro.md     | 6 +++++-
 examples/1ptracer/doc/tracerintro.md | 6 +++++-
 examples/1ptracer/main.cc            | 7 ++++---
 3 files changed, 14 insertions(+), 5 deletions(-)

diff --git a/examples/1ptracer/doc/1pintro.md b/examples/1ptracer/doc/1pintro.md
index 2a6e6b9e80..61a8f95eed 100644
--- a/examples/1ptracer/doc/1pintro.md
+++ b/examples/1ptracer/doc/1pintro.md
@@ -8,4 +8,8 @@ settings for the simulation. Two exemplary `properties`, that are mandatory to b
 specialized, are `Problem` and `SpatialParams`. With the first, one sets the
 `Problem` class to be used, in which users can define initial and boundary conditions.
 Similarly, in the `SpatialParams` class one implements the parameter distributions
-(e.g. porosity and permeability) that should be used.
+(e.g. porosity and permeability) that should be used by the model.
+
+The documentation provided in the sequel is structured as follows:
+
+[[_TOC_]]
diff --git a/examples/1ptracer/doc/tracerintro.md b/examples/1ptracer/doc/tracerintro.md
index f26897906e..9b64df8053 100644
--- a/examples/1ptracer/doc/tracerintro.md
+++ b/examples/1ptracer/doc/tracerintro.md
@@ -8,4 +8,8 @@ settings for the simulation. Two exemplary `properties`, that are mandatory to b
 specialized, are `Problem` and `SpatialParams`. With the first, one sets the
 `Problem` class to be used, in which users can define initial and boundary conditions.
 Similarly, in the `SpatialParams` class one implements the parameter distributions
-(e.g. porosity and permeability) that should be used.
+(e.g. porosity and permeability) that should be used by the model.
+
+The documentation provided in the sequel is structured as follows:
+
+[[_TOC_]]
diff --git a/examples/1ptracer/main.cc b/examples/1ptracer/main.cc
index cd51ba9f35..b1c6b23f88 100644
--- a/examples/1ptracer/main.cc
+++ b/examples/1ptracer/main.cc
@@ -17,14 +17,15 @@
  *   along with this program.  If not, see <http://www.gnu.org/licenses/>.   *
  *****************************************************************************/
 
-// ## Main program flow (`main.cc`)
+// # Main program flow (`main.cc`)
 //
+// [[_TOC_]]
 //
 // This file contains the main program flow. In this example, we solve a single-phase flow problem
 // to obtain a pressure distribution in the domain. Subsequently, the distribution of volume fluxes
 // is computed from that pressure distribution, which is then passed to a tracer problem to solve
 // the transport of an initial contamination through the model domain.
-// ### Included header files
+// ## Included header files
 // <details>
 // [[exclude]]
 // Some generic includes.
@@ -66,7 +67,7 @@
 // </details>
 //
 
-// ### The main function
+// ## The main function
 // We will now discuss the main program flow implemented within the `main` function.
 // At the beginning of each program using Dune, an instance of `Dune::MPIHelper` has to
 // be created. Moreover, we parse the run-time arguments from the command line and the
-- 
GitLab