From 0d2943133b5ec61640e33c8e2a3392a6ed4aa783 Mon Sep 17 00:00:00 2001 From: Timo Koch <timo.koch@iws.uni-stuttgart.de> Date: Wed, 27 May 2020 11:13:42 +0000 Subject: [PATCH] Merge branch 'cleanup/exclude-tests-doxygen' into 'master' [doxygen] exclude tests from doxygen to reduce doxygen size and runtime Closes #887 See merge request dumux-repositories/dumux!2141 (cherry picked from commit 85c43cf374007a626987b60862adebbf8dd218db) b6dbd314 [doxygen] exclude tests from doxygen to reduce doxygen size and runtime --- doc/doxygen/Doxylocal | 1 - doc/doxygen/modules.txt | 161 ---------------------------------------- 2 files changed, 162 deletions(-) diff --git a/doc/doxygen/Doxylocal b/doc/doxygen/Doxylocal index 9b85a30f9f..9e630cd500 100644 --- a/doc/doxygen/Doxylocal +++ b/doc/doxygen/Doxylocal @@ -13,7 +13,6 @@ PREDEFINED += "NEW_PROP_TAG(name)=Property tag name" \ INPUT += @srcdir@/mainpage.txt \ @srcdir@/modules.txt \ @top_srcdir@/dumux \ - @top_srcdir@/test \ @srcdir@/extradoc/parameterlist.txt EXAMPLE_PATH += @srcdir@/extradoc diff --git a/doc/doxygen/modules.txt b/doc/doxygen/modules.txt index 053abe0624..2fc7210cad 100644 --- a/doc/doxygen/modules.txt +++ b/doc/doxygen/modules.txt @@ -266,167 +266,6 @@ * For a detailed model decription see geomechanics/poroelastic/model.hh */ -/* ***************** Benchmarks and Tests ******************/ -/*! - * \defgroup BenchmarksAndTests Benchmarks and Tests - * \brief Benchmarks and tests used for (automated) testing and demonstration purposes - */ - /*! - * \ingroup BenchmarksAndTests - * \defgroup PorousmediumflowTests Porous-Medium Flow Tests - * \brief Single and multi-phase tests for flow and transport in porous materials - */ - /*! - * \ingroup PorousmediumflowTests - * \defgroup OnePTests 1p (one phase) benchmarks and tests - * \brief Various tests using a OnePModel. The files are listed below. - */ - /*! - * \ingroup PorousmediumflowTests - * \defgroup OnePNCTests 1pnc (one phase, multi-component) benchmarks and tests - * \brief Various tests using a OnePNCModel. The files are listed below. - */ - /*! - * \ingroup PorousmediumflowTests - * \defgroup OnePNCMinTests 1pncmin (one phase, multi-component mineralization) benchmarks and tests - * \brief Various tests using the OnePNCMinModel. The files are listed below. - */ - /*! - * \ingroup PorousmediumflowTests - * \defgroup TwoPTests 2p (two phase) benchmarks and tests - * \brief Various tests using a TwoPModel. The files are listed below. - */ - /*! - * \ingroup PorousmediumflowTests - * \defgroup TwoPOneCTests 2p1c (two phase, one component) benchmarks and tests - * \brief Various tests using the TwoPOneCModel. The files are listed below. - */ - /*! - * \ingroup PorousmediumflowTests - * \defgroup TwoPTwoCTests 2p2c (two phase, two component) benchmarks and tests - * \brief Various tests using a TwoPTwoCModel. The files are listed below. - */ - /*! - * \ingroup PorousmediumflowTests - * \defgroup TwoPNCTests 2pnc (two phase, multi-component) benchmarks and tests - * \brief A fuel cell test problem using the TwoPNCModel. The files are listed below. - */ - /*! - * \ingroup PorousmediumflowTests - * \defgroup TwoPNCMinTests 2pncmin (two phase, multi-component mineralization) benchmarks and tests - * \brief A salt dissolution test problem using the TwoPNCMinModel. The files are listed below. - */ - /*! - * \ingroup PorousmediumflowTests - * \defgroup ThreePTests 3p (three phase) benchmarks and tests - * \brief Various tests using a ThreePModel. The files are listed below. - */ - /*! - * \ingroup PorousmediumflowTests - * \defgroup ThreePThreeCTests 3p3c (three phase, three component) benchmarks and tests - * \brief Various tests using a ThreePThreeCModel. The files are listed below. - */ - /*! - * \ingroup PorousmediumflowTests - * \defgroup ThreePWaterOilTests 3pwateroil (three phase, water oil) benchmarks and tests - * \brief A SAGD test problem using the ThreePWaterOilModel. The files are listed below. - */ - /*! - * \ingroup PorousmediumflowTests - * \defgroup CO2Tests CO2 (two phase, two component) benchmarks and tests - * \brief A CO2 injection test problem using the TwoPTwoCModel and heterogeneous spatial parameters. The files are listed below. - */ - /*! - * \ingroup PorousmediumflowTests - * \defgroup MPNCTests MPNC (multi-phase, multi-component) benchmarks and tests - * \brief Various tests using the MPNCModel. The files are listed below. - */ - /*! - * \ingroup PorousmediumflowTests - * \defgroup RichardsTests Richards benchmarks and tests - * \brief Various tests using a RichardsModel. The files are listed below. - */ - /*! - * \ingroup PorousmediumflowTests - * \defgroup RichardsNCTests Richards multi-component benchmarks and tests - * \brief A multi-component transport problem in the unsaturated zone using the RichardsNCModel. The files are listed below. - */ - /*! - * \ingroup SolidEnergyTests - * \defgroup SolidEnergyTests Solid energy tests - * \brief Tests for the solid energy model. - */ - /*! - * \ingroup PorousmediumflowTests - * \defgroup TracerTests Tracer benchmarks and tests - * \brief Various tests using a TracerModel. The files are listed below. - */ - /*! - * \ingroup BenchmarksAndTests - * \defgroup FreeflowTests Free Flow Tests - * \brief Various tests for single-phase Navier-Stokes / Stokes tests - */ - /*! - * \ingroup FreeflowTests - * \defgroup NavierStokesTests Single-phase Navier-Stokes tests - * \brief Various tests using a single-phase Navier-Stokes flow. The files are listed below. - */ - /*! - * \ingroup FreeflowTests - * \defgroup NavierStokesNCTests Single-phase Navier-Stokes nc tests - * \brief Various tests using a single-phase Navier-Stokes flow with n components. The files are listed below. - */ - /*! - * \ingroup FreeflowTests - * \defgroup RANSTests Reynolds-Averaged Navier-Stokes tests - * \brief Various tests using a single-phase Reynolds-Averaged Navier-Stokes flow. The files are listed below. - */ - /*! - * \ingroup FreeflowTests - * \defgroup RANSNCTests Reynolds-Averaged Navier-Stokes nc tests - * \brief Various tests using a single-phase Reynolds-Averaged Navier-Stokes flow with n components. The files are listed below. - */ - /*! - * \ingroup FreeflowTests - * \defgroup ShallowWaterTests 2D shallow water tests - * \brief Tests for the two-dimensional shallow water model. The files are listed below. - */ - /*! - * \ingroup BenchmarksAndTests - * \defgroup GeomechanicsTests Geomechanics Tests - * \brief Various tests using the geomechanics elastic or poroelastic models. The files are listed below. - */ - /*! - * \ingroup BenchmarksAndTests - * \defgroup MaterialTests Material system tests - * \brief Benchmarks and Test(s) for the material system. - */ - /*! - * \ingroup BenchmarksAndTests - * \defgroup MultiDomainTests MultiDomain tests - * \brief Various tests for multidomain problems. - */ - /*! - * \ingroup MultiDomainTests - * \defgroup BoundaryTests MultiDomain boundary tests - * \brief Various tests using a boundary as coupling interface: Darcy-Stokes coupling or PNM (pore network model)-Darcy. The files are listed below. - */ - /*! - * \ingroup MultiDomainTests - * \defgroup EmbeddedTests Embedded MultiDomain tests - * \brief Various tests for embedded coupling problems with different dimensions: Root-soil interaction or embedded fracture models. The files are listed below. - */ - /*! - * \ingroup MultiDomainTests - * \defgroup FacetTests Facet MultiDomain tests - * \brief Various tests for facet coupling problems with different dimensions: Discrete facet conforming fracture models and problems with physics on a domain surface. The files are listed below. - */ - /*! - * \ingroup MultiDomainTests - * \defgroup PoromechanicsTests Facet MultiDomain tests - * \brief Various tests coupling poromechanics and fluid flow. The files are listed below. - */ - /* ***************** Discretization ******************/ /*! * \defgroup Discretization Discretization schemes -- GitLab