From b5247675b42b9bae2aa1fd5834b6a55d4c611a52 Mon Sep 17 00:00:00 2001 From: Timo Koch <timo.koch@iws.uni-stuttgart.de> Date: Sat, 1 Dec 2018 12:39:33 +0100 Subject: [PATCH] [doxygen] Hide co2 tables include from doxygen --- dumux/material/fluidsystems/brineco2.hh | 2 ++ .../poromechanics/el2p/co2tables_el2p.hh | 17 ++++++++--------- test/porousmediumflow/co2/implicit/co2tables.hh | 9 ++++----- 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/dumux/material/fluidsystems/brineco2.hh b/dumux/material/fluidsystems/brineco2.hh index 13e69e40c7..a912651f5e 100644 --- a/dumux/material/fluidsystems/brineco2.hh +++ b/dumux/material/fluidsystems/brineco2.hh @@ -46,7 +46,9 @@ namespace Dumux { // include the default tables for CO2 +#ifndef DOXYGEN // hide tables from doxygen #include <dumux/material/components/co2tables.inc> +#endif namespace FluidSystems { namespace Detail { diff --git a/test/multidomain/poromechanics/el2p/co2tables_el2p.hh b/test/multidomain/poromechanics/el2p/co2tables_el2p.hh index f7d4913b67..953fa20ec1 100644 --- a/test/multidomain/poromechanics/el2p/co2tables_el2p.hh +++ b/test/multidomain/poromechanics/el2p/co2tables_el2p.hh @@ -27,19 +27,18 @@ #include <cassert> #include <dumux/material/components/co2tablereader.hh> -namespace Dumux -{ -namespace El2P -{ -/*! -* \brief Class providing the tabulated values of CO2 for density and enthalpy -*/ +namespace Dumux { +namespace El2P { + +// Class providing the tabulated values of CO2 for density and enthalpy // the real work is done by some external program which provides // ready-to-use tables. +#ifndef DOXYGEN // hide tables from doxygen #include "co2values.inc" +#endif -} -} +} // end namespace El2P +} // end namespace Dumux #endif diff --git a/test/porousmediumflow/co2/implicit/co2tables.hh b/test/porousmediumflow/co2/implicit/co2tables.hh index 42e3e04e1c..85d79da5d5 100644 --- a/test/porousmediumflow/co2/implicit/co2tables.hh +++ b/test/porousmediumflow/co2/implicit/co2tables.hh @@ -28,16 +28,15 @@ #include <dumux/material/components/co2tablereader.hh> namespace Dumux { -/** - * \ingroup CO2Tests - * \brief Provides the class with the tabulated values of CO2 density - * and enthalpy - */ + +// Provides the class with the tabulated values of CO2 density and enthalpy namespace HeterogeneousCO2Tables { +#ifndef DOXYGEN // hide from doxygen // the real work is done by some external program which provides // ready-to-use tables. #include "co2values.inc" +#endif } // end namespace HeterogeneousCO2Tables } // end namespace Dumux -- GitLab