From e32b596b6983d77bc9478ccff3872b827d00d12e Mon Sep 17 00:00:00 2001
From: Katharina Heck <katharina.heck@iws.uni-stuttgart.de>
Date: Tue, 27 Sep 2016 17:27:37 +0200
Subject: [PATCH] [fix/doxygen] fixes copydocs of fluidmatrixinteraction
problems
---
dumux/io/container.hh | 4 ++--
.../effectivediffusivityconstantproblem.hh | 8 +++++++-
.../effectivediffusivityconstanttauproblem.hh | 8 +++++++-
.../effectivediffusivitymillingtonquirkproblem.hh | 8 +++++++-
4 files changed, 23 insertions(+), 5 deletions(-)
diff --git a/dumux/io/container.hh b/dumux/io/container.hh
index 5f81750cd6..5e5f495abd 100644
--- a/dumux/io/container.hh
+++ b/dumux/io/container.hh
@@ -36,7 +36,7 @@ namespace Dumux {
* \param v The container, requires being() and end() method
* \param filename The filename to write to
*
- * \usage std::vector<double>(5, 0.0) v; writeContainerToFile(v, "myvector.txt");
+ * usage: std::vector<double>(5, 0.0) v; writeContainerToFile(v, "myvector.txt");
*/
template<typename Container>
void writeContainerToFile(const Container& v,
@@ -52,7 +52,7 @@ void writeContainerToFile(const Container& v,
* \param filename The filename to write to
* \tparam Container The container type, requires being(), end(), push_back() method
*
- * \usage auto v = readFileToContainer<std::vector<double>>("myvector.txt");
+ * usage: auto v = readFileToContainer<std::vector<double>>("myvector.txt");
*/
template<typename Container>
Container readFileToContainer(const std::string& filename)
diff --git a/test/material/fluidmatrixinteractions/effectivediffusivityconstantproblem.hh b/test/material/fluidmatrixinteractions/effectivediffusivityconstantproblem.hh
index d08b43e34a..eb4b563fbd 100644
--- a/test/material/fluidmatrixinteractions/effectivediffusivityconstantproblem.hh
+++ b/test/material/fluidmatrixinteractions/effectivediffusivityconstantproblem.hh
@@ -191,7 +191,13 @@ public:
}
- //! \copydoc InjectionProblem::initialPhasePresence()
+ /*!
+ * \brief Returns the initial phase state for a control volume.
+ *
+ * \param vertex The vertex
+ * \param vIdxGlobal The global index of the vertex
+ * \param globalPos The position of the center of the element
+ */
int initialPhasePresence(const Vertex &vertex,
int &vIdxGlobal,
const GlobalPosition &globalPos) const
diff --git a/test/material/fluidmatrixinteractions/effectivediffusivityconstanttauproblem.hh b/test/material/fluidmatrixinteractions/effectivediffusivityconstanttauproblem.hh
index b0fccd9a90..5b1a9b00b0 100644
--- a/test/material/fluidmatrixinteractions/effectivediffusivityconstanttauproblem.hh
+++ b/test/material/fluidmatrixinteractions/effectivediffusivityconstanttauproblem.hh
@@ -191,7 +191,13 @@ public:
}
- //! \copydoc InjectionProblem::initialPhasePresence()
+ /*!
+ * \brief Returns the initial phase state for a control volume.
+ *
+ * \param vertex The vertex
+ * \param vIdxGlobal The global index of the vertex
+ * \param globalPos The position of the center of the element
+ */
int initialPhasePresence(const Vertex &vertex,
int &vIdxGlobal,
const GlobalPosition &globalPos) const
diff --git a/test/material/fluidmatrixinteractions/effectivediffusivitymillingtonquirkproblem.hh b/test/material/fluidmatrixinteractions/effectivediffusivitymillingtonquirkproblem.hh
index 089f0481c5..421e3dfa34 100644
--- a/test/material/fluidmatrixinteractions/effectivediffusivitymillingtonquirkproblem.hh
+++ b/test/material/fluidmatrixinteractions/effectivediffusivitymillingtonquirkproblem.hh
@@ -191,7 +191,13 @@ public:
}
- //! \copydoc InjectionProblem::initialPhasePresence()
+ /*!
+ * \brief Returns the initial phase state for a control volume.
+ *
+ * \param vertex The vertex
+ * \param vIdxGlobal The global index of the vertex
+ * \param globalPos The position of the center of the element
+ */
int initialPhasePresence(const Vertex &vertex,
int &vIdxGlobal,
const GlobalPosition &globalPos) const
--
GitLab