From 7bc37072ce2d6f81614cdd2007cab4cc650386e6 Mon Sep 17 00:00:00 2001
From: Timo Koch <timo.koch@iws.uni-stuttgart.de>
Date: Wed, 1 Apr 2020 17:59:31 +0200
Subject: [PATCH] [examples][2p] Allow to fold source code doc
---
examples/2pinfiltration/README.md | 32 +++++++++++++++++++++++-
examples/2pinfiltration/main.cc | 3 ++-
examples/2pinfiltration/problem.hh | 6 ++++-
examples/2pinfiltration/properties.hh | 4 ++-
examples/2pinfiltration/spatialparams.hh | 10 ++++----
5 files changed, 46 insertions(+), 9 deletions(-)
diff --git a/examples/2pinfiltration/README.md b/examples/2pinfiltration/README.md
index ebf00a2315..b0d3814b7a 100644
--- a/examples/2pinfiltration/README.md
+++ b/examples/2pinfiltration/README.md
@@ -75,7 +75,11 @@ For more information about the discretization please have a look at the [handboo
## The file `spatialparams.hh`
+<details open>
+<summary><b>Click to hide/show the file documentation</b> (or inspect the [source code](spatialparams.hh))</summary>
+
+### Includes
we include the basic spatial parameters for finite volumes file from which we will inherit
```cpp
@@ -94,7 +98,6 @@ namespace Dumux {
In the TwoPTestSpatialParams class we define all functions needed to describe the porous matrix, e.g. porosity and permeability
```cpp
-
template<class GridGeometry, class Scalar>
class TwoPTestSpatialParams
: public FVSpatialParams<GridGeometry, Scalar, TwoPTestSpatialParams<GridGeometry, Scalar>>
@@ -235,9 +238,18 @@ we have a convenience definition of the position of the lens
```
+</details>
+
+----------
## The file `problem.hh`
+
+<details open>
+<summary><b>Click to hide/show the file documentation</b> (or inspect the [source code](problem.hh))</summary>
+
+
+### Includes
We start with includes for `PorousMediumFlowProblem` and `readFileToContainer` (used below).
```cpp
@@ -245,6 +257,7 @@ We start with includes for `PorousMediumFlowProblem` and `readFileToContainer` (
#include <dumux/io/container.hh>
```
+### Problem class
The problem class `PointSourceProblem` implements boundary and initial conditions.
It derives from the `PorousMediumFlowProblem` class.
@@ -444,10 +457,18 @@ private:
</details>
+</details>
+
+----------
## The file `properties.hh`
+<details open>
+<summary><b>Click to hide/show the file documentation</b> (or inspect the [source code](properties.hh))</summary>
+
+
+### Includes
The header includes will be mentioned in the text below.
<details><summary>Click to show the header includes</summary>
@@ -564,10 +585,16 @@ struct Formulation<TypeTag, TTag::PointSourceExample>
```
+</details>
+
+----------
## The file `main.cc`
+<details open>
+<summary><b>Click to hide/show the file documentation</b> (or inspect the [source code](main.cc))</summary>
+
This is the main file for the 2pinfiltration example. Here we can see the programme sequence and how the system is solved using Newton's method
### Includes
@@ -1090,3 +1117,6 @@ catch (...)
```
+</details>
+
+----------
diff --git a/examples/2pinfiltration/main.cc b/examples/2pinfiltration/main.cc
index 72011070b8..32b1fbbc18 100644
--- a/examples/2pinfiltration/main.cc
+++ b/examples/2pinfiltration/main.cc
@@ -17,7 +17,7 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
// ## The file `main.cc`
-//
+// [[content]]
//
// This is the main file for the 2pinfiltration example. Here we can see the programme sequence and how the system is solved using Newton's method
// ### Includes
@@ -303,3 +303,4 @@ catch (...)
std::cerr << "Unknown exception thrown! ---> Abort!" << std::endl;
return 4;
}
+// [[/content]]
diff --git a/examples/2pinfiltration/problem.hh b/examples/2pinfiltration/problem.hh
index 9dcf4b6c04..8fb6e92095 100644
--- a/examples/2pinfiltration/problem.hh
+++ b/examples/2pinfiltration/problem.hh
@@ -21,10 +21,14 @@
#define DUMUX_EXAMPLE_TWOP_INFILTRATION_PROBLEM_HH
// ## The file `problem.hh`
+// [[content]]
+//
+// ### Includes
// We start with includes for `PorousMediumFlowProblem` and `readFileToContainer` (used below).
#include <dumux/porousmediumflow/problem.hh>
#include <dumux/io/container.hh>
+// ### Problem class
// The problem class `PointSourceProblem` implements boundary and initial conditions.
// It derives from the `PorousMediumFlowProblem` class.
namespace Dumux {
@@ -198,5 +202,5 @@ private:
} // end namespace Dumux
// </details>
-
+// [[/content]]
#endif
diff --git a/examples/2pinfiltration/properties.hh b/examples/2pinfiltration/properties.hh
index f73a61ccc1..31a977f215 100644
--- a/examples/2pinfiltration/properties.hh
+++ b/examples/2pinfiltration/properties.hh
@@ -21,7 +21,9 @@
#define DUMUX_EXAMPLE_TWOP_INFILTRATION_PROPERTIES_HH
// ## The file `properties.hh`
+// [[content]]
//
+// ### Includes
// The header includes will be mentioned in the text below.
// <details><summary>Click to show the header includes</summary>
#include <dune/alugrid/grid.hh>
@@ -117,5 +119,5 @@ struct Formulation<TypeTag, TTag::PointSourceExample>
{ static constexpr auto value = TwoPFormulation::p0s1; };
} // end namespace Dumux::Properties
-
+// [[/content]]
#endif
diff --git a/examples/2pinfiltration/spatialparams.hh b/examples/2pinfiltration/spatialparams.hh
index f8b4bd01b3..14cd6a117e 100644
--- a/examples/2pinfiltration/spatialparams.hh
+++ b/examples/2pinfiltration/spatialparams.hh
@@ -21,9 +21,10 @@
#define DUMUX_TWOP_INCOMPRESSIBLE_EXAMPLE_SPATIAL_PARAMS_HH
// ## The file `spatialparams.hh`
+// [[content]]
//
-//
-//we include the basic spatial parameters for finite volumes file from which we will inherit
+// ### Includes
+// we include the basic spatial parameters for finite volumes file from which we will inherit
#include <dumux/material/spatialparams/fv.hh>
// we include all laws which are needed to define the interaction between the solid matrix and the fluids, e.g. laws for capillary pressure saturation relationships.
@@ -32,8 +33,7 @@
namespace Dumux {
-//In the TwoPTestSpatialParams class we define all functions needed to describe the porous matrix, e.g. porosity and permeability
-
+// In the TwoPTestSpatialParams class we define all functions needed to describe the porous matrix, e.g. porosity and permeability
template<class GridGeometry, class Scalar>
class TwoPTestSpatialParams
: public FVSpatialParams<GridGeometry, Scalar, TwoPTestSpatialParams<GridGeometry, Scalar>>
@@ -139,5 +139,5 @@ private:
};
} // end namespace Dumux
-
+// [[/content]]
#endif
--
GitLab