From 0ad0a9ce49ec60f1c6c93a3a16f30939de938f95 Mon Sep 17 00:00:00 2001
From: Simon Scholz <simon.scholz@iws.uni-stuttgart.de>
Date: Wed, 20 Dec 2017 17:26:02 +0100
Subject: [PATCH] [doxygen] fix doxygen in spatialparams
---
dumux/material/spatialparams/CMakeLists.txt | 7 ++--
dumux/material/spatialparams/fv.hh | 5 ---
dumux/material/spatialparams/fv1p.hh | 4 ---
.../spatialparams/gstatrandomfield.hh | 34 +++++++++----------
dumux/material/spatialparams/sequentialfv.hh | 4 ---
.../material/spatialparams/sequentialfv1p.hh | 5 ---
6 files changed, 20 insertions(+), 39 deletions(-)
diff --git a/dumux/material/spatialparams/CMakeLists.txt b/dumux/material/spatialparams/CMakeLists.txt
index 5d3a46d651..bd834d827b 100644
--- a/dumux/material/spatialparams/CMakeLists.txt
+++ b/dumux/material/spatialparams/CMakeLists.txt
@@ -1,8 +1,9 @@
#install headers
install(FILES
-fv1p.hh
fv.hh
-implicit1p.hh
-implicit.hh
+fv1p.hh
+gstatrandomfield.hh
+sequentialfv.hh
+sequentialfv1p.hh
DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/dumux/material/spatialparams)
diff --git a/dumux/material/spatialparams/fv.hh b/dumux/material/spatialparams/fv.hh
index b0e7102061..d53477d5ab 100644
--- a/dumux/material/spatialparams/fv.hh
+++ b/dumux/material/spatialparams/fv.hh
@@ -18,7 +18,6 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup SpatialParameters
* \brief The base class for spatial parameters of multi-phase problems
* using a fully implicit discretization method.
@@ -34,10 +33,6 @@ namespace Dumux {
/*!
* \ingroup SpatialParameters
- */
-
-
-/**
* \brief The base class for spatial parameters of multi-phase problems
* using a fully implicit discretization method.
*/
diff --git a/dumux/material/spatialparams/fv1p.hh b/dumux/material/spatialparams/fv1p.hh
index b5d73a51a4..5ee11e1185 100644
--- a/dumux/material/spatialparams/fv1p.hh
+++ b/dumux/material/spatialparams/fv1p.hh
@@ -18,7 +18,6 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup SpatialParameters
* \brief The base class for spatial parameters of one-phase problems
* using a fully implicit discretization method.
@@ -37,9 +36,6 @@ namespace Dumux {
/*!
* \ingroup SpatialParameters
- */
-
-/**
* \brief The base class for spatial parameters of one-phase problems
* using a fully implicit discretization method.
*/
diff --git a/dumux/material/spatialparams/gstatrandomfield.hh b/dumux/material/spatialparams/gstatrandomfield.hh
index c6c51b8aea..a3611abd25 100644
--- a/dumux/material/spatialparams/gstatrandomfield.hh
+++ b/dumux/material/spatialparams/gstatrandomfield.hh
@@ -18,7 +18,6 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup SpatialParameters
* \brief Creating random fields using gstat
*/
@@ -77,23 +76,22 @@ public:
, data_(gridView.size(0))
{}
- /*!
- * \brief Creates a new field with random variables, if desired.
- * Otherwise creates a data field from already available data.
- * For the random field generation three files are necessary.
- *
- * A \a gstatControlFile in which all commands and in/output files for gstat are specified.
- * A \a gstatInputFile contains all coordinates (cell centers) of the grid, so that
- * gstat can perform its random realization. The filename must be same as in the gstatControlFile.
- * A \a gstatOutputFile in which gstat writes the random values to this file.
- * The filename must be the same as in the gstatControlFile.
- * \param fieldType
- * \param gstatControlFile name of control file for gstat
- * \param gstatInputFile name of input file for gstat
- * \param gstatOutputFile name of the gstat output file
- * \param createNew set true to create a new field
- */
-
+ /*!
+ * \brief Creates a new field with random variables, if desired.
+ * Otherwise creates a data field from already available data.
+ * For the random field generation three files are necessary.
+ *
+ * A \a gstatControlFile in which all commands and in/output files for gstat are specified.
+ * A \a gstatInputFile contains all coordinates (cell centers) of the grid, so that
+ * gstat can perform its random realization. The filename must be same as in the gstatControlFile.
+ * A \a gstatOutputFile in which gstat writes the random values to this file.
+ * The filename must be the same as in the gstatControlFile.
+ * \param fieldType
+ * \param gstatControlFile name of control file for gstat
+ * \param gstatInputFile name of input file for gstat
+ * \param gstatOutputFile name of the gstat output file
+ * \param createNew set true to create a new field
+ */
void create(const std::string& gstatControlFile,
const std::string& gstatInputFile = "gstatInput.txt",
const std::string& gstatOutputFile = "permeab.dat",
diff --git a/dumux/material/spatialparams/sequentialfv.hh b/dumux/material/spatialparams/sequentialfv.hh
index fafa8a703b..1f214c28db 100644
--- a/dumux/material/spatialparams/sequentialfv.hh
+++ b/dumux/material/spatialparams/sequentialfv.hh
@@ -18,7 +18,6 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup SpatialParameters
* \brief The base class for spatial parameters of problems using the
* fv method.
@@ -33,9 +32,6 @@ namespace Dumux
{
/*!
* \ingroup SpatialParameters
- */
-
-/**
* \brief The base class for spatial parameters of a multi-phase problem using the
* fv method.
*/
diff --git a/dumux/material/spatialparams/sequentialfv1p.hh b/dumux/material/spatialparams/sequentialfv1p.hh
index 211389183c..1f19e64005 100644
--- a/dumux/material/spatialparams/sequentialfv1p.hh
+++ b/dumux/material/spatialparams/sequentialfv1p.hh
@@ -18,7 +18,6 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup SpatialParameters
* \brief The base class for spatial parameters of problems using the
* fv method.
@@ -39,12 +38,8 @@ namespace Properties
NEW_PROP_TAG(SpatialParams);
}
-
/*!
* \ingroup SpatialParameters
- */
-
-/**
* \brief The base class for spatial parameters of problems using the
* fv method.
*/
--
GitLab