From 3680eca54e71f90934e67363ca62d46ed2141451 Mon Sep 17 00:00:00 2001
From: Kilian Weishaupt <kilian.weishaupt@iws.uni-stuttgart.de>
Date: Wed, 23 Mar 2016 17:50:28 +0100
Subject: [PATCH] [doxygen] Fix issues related to @copydoc and \copydetails
*Use the full namespace Dumux::xxx::xxx to avoid error messages
---
.../2p/regularizedbrookscorey.hh | 16 +++++-----
.../2p/regularizedvangenuchten.hh | 16 +++++-----
dumux/material/fluidstates/nonequilibrium.hh | 30 +++++++++----------
3 files changed, 31 insertions(+), 31 deletions(-)
diff --git a/dumux/material/fluidmatrixinteractions/2p/regularizedbrookscorey.hh b/dumux/material/fluidmatrixinteractions/2p/regularizedbrookscorey.hh
index 3d170470e9..35c9bd6c00 100644
--- a/dumux/material/fluidmatrixinteractions/2p/regularizedbrookscorey.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/regularizedbrookscorey.hh
@@ -79,7 +79,7 @@ public:
*
* For the non-regularized part:
*
- * \copydetails BrooksCorey::pc()
+ * \copydetails Dumux::BrooksCorey::pc()
*/
static Scalar pc(const Params ¶ms, Scalar swe)
{
@@ -119,7 +119,7 @@ public:
*
* For the non-regularized part:
*
- * \copydetails BrooksCorey::sw()
+ * \copydetails Dumux::BrooksCorey::sw()
*/
static Scalar sw(const Params ¶ms, Scalar pc)
{
@@ -163,7 +163,7 @@ public:
*
* For the non-regularized part:
*
- * \copydetails BrooksCorey::dpc_dsw()
+ * \copydetails Dumux::BrooksCorey::dpc_dsw()
*/
DUNE_DEPRECATED_MSG("dpc_dsw(const Params ¶ms, Scalar swe) is deprecated. Use dpc_dswe(const Params ¶ms, Scalar swe) instead.")
static Scalar dpc_dsw(const Params ¶ms, Scalar swe)
@@ -183,7 +183,7 @@ public:
*
* For the non-regularized part:
*
- * \copydetails BrooksCorey::dpc_dswe()
+ * \copydetails Dumux::BrooksCorey::dpc_dswe()
*/
static Scalar dpc_dswe(const Params ¶ms, Scalar swe)
{
@@ -216,7 +216,7 @@ public:
*
* For the non-regularized part:
*
- * \copydetails BrooksCorey::dsw_dpc()
+ * \copydetails Dumux::BrooksCorey::dsw_dpc()
*/
DUNE_DEPRECATED_MSG("dsw_dpc(const Params ¶ms, Scalar pc) is deprecated. Use dswe_dpc(const Params ¶ms, Scalar pc) instead.")
static Scalar dsw_dpc(const Params ¶ms, Scalar pc)
@@ -236,7 +236,7 @@ public:
*
* For the non-regularized part:
*
- * \copydetails BrooksCorey::dswe_dpc()
+ * \copydetails Dumux::BrooksCorey::dswe_dpc()
*/
static Scalar dswe_dpc(const Params ¶ms, Scalar pc)
{
@@ -283,7 +283,7 @@ public:
* - between \f$\mathrm{ 0.95 \leq \overline{S}_w \leq 1}\f$: use a spline as interpolation
*
* For not-regularized part:
- \copydetails BrooksCorey::krw()
+ \copydetails Dumux::BrooksCorey::krw()
*/
static Scalar krw(const Params ¶ms, Scalar swe)
{
@@ -306,7 +306,7 @@ public:
* - above \f$\mathrm{\overline{S}_w =1}\f$: set relative permeability to one
* - for \f$\mathrm{0 \leq \overline{S}_w \leq 0.05}\f$: use a spline as interpolation
*
- \copydetails BrooksCorey::krn()
+ \copydetails Dumux::BrooksCorey::krn()
*
*/
static Scalar krn(const Params ¶ms, Scalar swe)
diff --git a/dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchten.hh b/dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchten.hh
index bf9133a399..e13a04068a 100644
--- a/dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchten.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchten.hh
@@ -88,7 +88,7 @@ public:
*
* For not-regularized part:
*
- \copydetails VanGenuchten::pc()
+ \copydetails Dumux::VanGenuchten::pc()
*/
static Scalar pc(const Params ¶ms, Scalar swe)
{
@@ -141,7 +141,7 @@ public:
*
* For not-regularized part:
*
- \copydetails VanGenuchten::sw()
+ \copydetails Dumux::VanGenuchten::sw()
*
*/
static Scalar sw(const Params ¶ms, Scalar pc)
@@ -199,7 +199,7 @@ public:
*
* For not-regularized part:
*
- \copydetails VanGenuchten::dpc_dsw()
+ \copydetails Dumux::VanGenuchten::dpc_dsw()
*
*/
DUNE_DEPRECATED_MSG("dpc_dsw(const Params ¶ms, Scalar swe) is deprecated. Use dpc_dswe(const Params ¶ms, Scalar swe) instead.")
@@ -220,7 +220,7 @@ public:
*
* For not-regularized part:
*
- \copydetails VanGenuchten::dpc_dswe()
+ \copydetails Dumux::VanGenuchten::dpc_dswe()
*
*/
static Scalar dpc_dswe(const Params ¶ms, Scalar swe)
@@ -249,7 +249,7 @@ public:
* by a straight line and use that slope (yes, there is a kink :-( ).
*
* For not-regularized part:
- \copydetails VanGenuchten::dsw_dpc()
+ \copydetails Dumux::VanGenuchten::dsw_dpc()
*/
DUNE_DEPRECATED_MSG("dsw_dpc(const Params ¶ms, Scalar pc) is deprecated. Use dswe_dpc(const Params ¶ms, Scalar pc) instead.")
static Scalar dsw_dpc(const Params ¶ms, Scalar pc)
@@ -268,7 +268,7 @@ public:
* by a straight line and use that slope (yes, there is a kink :-( ).
*
* For not-regularized part:
- \copydetails VanGenuchten::dswe_dpc()
+ \copydetails Dumux::VanGenuchten::dswe_dpc()
*/
static Scalar dswe_dpc(const Params ¶ms, Scalar pc)
{
@@ -306,7 +306,7 @@ public:
* - between \f$\mathrm{0.95 \leq \overline{S}_w \leq 1}\f$: use a spline as interpolation
*
* For not-regularized part:
- \copydetails VanGenuchten::krw()
+ \copydetails Dumux::VanGenuchten::krw()
*/
static Scalar krw(const Params ¶ms, Scalar swe)
{
@@ -341,7 +341,7 @@ public:
* - above \f$\mathrm{\overline{S}_w =1}\f$: set relative permeability to one
* - for \f$\mathrm{0 \leq \overline{S}_w \leq 0.05}\f$: use a spline as interpolation
*
- \copydetails VanGenuchten::krn()
+ \copydetails Dumux::VanGenuchten::krn()
*
*/
static Scalar krn(const Params ¶ms, Scalar swe)
diff --git a/dumux/material/fluidstates/nonequilibrium.hh b/dumux/material/fluidstates/nonequilibrium.hh
index 5289869f80..c5ff0033ea 100644
--- a/dumux/material/fluidstates/nonequilibrium.hh
+++ b/dumux/material/fluidstates/nonequilibrium.hh
@@ -68,20 +68,20 @@ public:
* on thermodynamic equilibrium required)
*****************************************************/
/*!
- * @copydoc CompositionalFluidState::saturation()
+ * @copydoc Dumux::CompositionalFluidState::saturation()
*/
Scalar saturation(int phaseIdx) const
{ return saturation_[phaseIdx]; }
/*!
- * @copydoc CompositionalFluidState::moleFraction()
+ * @copydoc Dumux::CompositionalFluidState::moleFraction()
*/
Scalar moleFraction(int phaseIdx, int compIdx) const
{ return moleFraction_[phaseIdx][compIdx]; }
/*!
- * @copydoc CompositionalFluidState::massFraction()
+ * @copydoc Dumux::CompositionalFluidState::massFraction()
*/
Scalar massFraction(int phaseIdx, int compIdx) const
{
@@ -93,67 +93,67 @@ public:
}
/*!
- * @copydoc CompositionalFluidState::averageMolarMass()
+ * @copydoc Dumux::CompositionalFluidState::averageMolarMass()
*/
Scalar averageMolarMass(int phaseIdx) const
{ return averageMolarMass_[phaseIdx]; }
/*!
- * @copydoc CompositionalFluidState::molarity()
+ * @copydoc Dumux::CompositionalFluidState::molarity()
*/
Scalar molarity(int phaseIdx, int compIdx) const
{ return molarDensity(phaseIdx)*moleFraction(phaseIdx, compIdx); }
/*!
- * @copydoc CompositionalFluidState::fugacityCoefficient()
+ * @copydoc Dumux::CompositionalFluidState::fugacityCoefficient()
*/
Scalar fugacityCoefficient(int phaseIdx, int compIdx) const
{ return fugacityCoefficient_[phaseIdx][compIdx]; }
/*!
- * @copydoc CompositionalFluidState::fugacity()
+ * @copydoc Dumux::CompositionalFluidState::fugacity()
*/
Scalar fugacity(int phaseIdx, int compIdx) const
{ return pressure_[phaseIdx]*fugacityCoefficient_[phaseIdx][compIdx]*moleFraction_[phaseIdx][compIdx]; }
/*!
- * @copydoc CompositionalFluidState::molarVolume()
+ * @copydoc Dumux::CompositionalFluidState::molarVolume()
*/
Scalar molarVolume(int phaseIdx) const
{ return 1/molarDensity(phaseIdx); }
/*!
- * @copydoc CompositionalFluidState::density()
+ * @copydoc Dumux::CompositionalFluidState::density()
*/
Scalar density(int phaseIdx) const
{ return density_[phaseIdx]; }
/*!
- * @copydoc CompositionalFluidState::molarDensity()
+ * @copydoc Dumux::CompositionalFluidState::molarDensity()
*/
Scalar molarDensity(int phaseIdx) const
{ return density_[phaseIdx]/averageMolarMass(phaseIdx); }
/*!
- * @copydoc CompositionalFluidState::temperature()
+ * @copydoc Dumux::CompositionalFluidState::temperature()
*/
Scalar temperature(int phaseIdx) const
{ return temperature_[phaseIdx]; }
/*!
- * @copydoc CompositionalFluidState::pressure()
+ * @copydoc Dumux::CompositionalFluidState::pressure()
*/
Scalar pressure(int phaseIdx) const
{ return pressure_[phaseIdx]; }
/*!
- * @copydoc CompositionalFluidState::enthalpy()
+ * @copydoc Dumux::CompositionalFluidState::enthalpy()
*/
Scalar enthalpy(int phaseIdx) const
{ return enthalpy_[phaseIdx]; }
/*!
- * @copydoc CompositionalFluidState::internalEnergy()
+ * @copydoc Dumux::CompositionalFluidState::internalEnergy()
*/
Scalar internalEnergy(int phaseIdx) const
{
@@ -162,7 +162,7 @@ public:
}
/*!
- * @copydoc CompositionalFluidState::viscosity()
+ * @copydoc Dumux::CompositionalFluidState::viscosity()
*/
Scalar viscosity(int phaseIdx) const
{ return viscosity_[phaseIdx]; }
--
GitLab