[swe][doxygen] Use doxygen for the SWEs

doc/doxygen/modules.txt

@@ -232,6 +232,13 @@
      * \copydetails ./freeflow/nonisothermal/model.hh
      */
 
+/* ***************** Shallowwater ******************/
+/*!
+ * \defgroup SweModel Shallow Water Models
+ * \brief Models basing on the 2D shallow water equation
+ * \copydetails ./shallowwater/swe/model.hh
+ */
+
 /* ***************** Benchmarks and Tests ******************/
 /*!
  * \defgroup BenchmarksAndTests Benchmarks and Tests
@@ -337,6 +344,11 @@
           * \defgroup NavierStokesNCTests Single-phase Navier-Stokes nc tests
           * \brief Various tests using a Single-phase Navier-Stokes flow. The files are listed below.
           */
+    /*!
+      * \ingroup BenchmarksAndTests
+      * \defgroup SweTests Shallow Water Tests
+      * \brief Tests for shallow water flow.
+      */
     /*!
       * \ingroup BenchmarksAndTests
       * \defgroup MaterialTests Material system tests
@@ -368,6 +380,12 @@
          * \defgroup CCMpfaDiscretization Multi-point flux approximation (Mpfa)
          * \brief A cell-centered finite volume scheme with multi-point flux approximation.
          */
+        /*!
+         * \ingroup CCDiscretization
+         * \defgroup GodunovDiscretization Godunov discretisation
+         * \brief A cell-centered finite volume scheme with godunov
+         * discretisation.
+         */
     /*!
      * \ingroup Discretization
      * \defgroup StaggeredDiscretization Staggered FV scheme

dumux/shallowwater/advectiveflux.hh

@@ -16,6 +16,13 @@
  *   You should have received a copy of the GNU General Public License       *
  *   along with this program.  If not, see <http://www.gnu.org/licenses/>.   *
  *****************************************************************************/
+
+/*!
+ * \file
+ * \ingroup SweModel
+ * \brief Defines the advective flux for the shallow water Model.
+ */
+
 #ifndef DUMUX_SHALLOW_WATER_ADVECTIVE_FLUX_HH
 #define DUMUX_SHALLOW_WATER_ADVECTIVE_FLUX_HH
 

dumux/shallowwater/numericalfluxes/boundaryFluxes.hh

@@ -18,7 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
- * \ingroup CCTpfaDiscretization
+ * \ingroup SweModel
  * \brief Compute the boundary fluxes based on the Riemann invariants
  *
  *        bdType can be:

dumux/shallowwater/numericalfluxes/exactriemannsolver.hh

@@ -18,7 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
- * \ingroup CCTpfaDiscretization
+ * \ingroup SweModel
  * \brief Exact Riemann solver for shallow water equations using
  *        two-point flux approximation.
  */

dumux/shallowwater/numericalfluxes/fluxrotation.hh

@@ -18,7 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
- * \ingroup CCTpfaDiscretization
+ * \ingroup SweModel
  * \brief Rotate the flux using the rotation invarianz of the SWEs
  *        two-point flux approximation.
  */

dumux/shallowwater/numericalfluxes/letmodel.hh

@@ -18,7 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
- * \ingroup Discretization
+ * \ingroup SweModel
  * \brief Simple model to compute a mobility of water
  *        for small water depths the mobility gets zero.
  *        No limitation for the momentum terms!

dumux/shallowwater/swe/fluxvariablescache.hh

@@ -18,6 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
+ * \ingroup SweModel
  * \brief Base class for the flux variables
  */
 #ifndef DUMUX_GODUNOV_FLUXVARIABLESCACHE_HH
@@ -40,7 +41,7 @@ class SweFluxVariablesCacheImplementation;
 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
 /*!
- * \ingroup ImplicitModel
+ * \ingroup SweModel
  * \brief The flux variables cache classes for porous media.
  *        Store data required for flux calculation. For each type of physical process (advection, diffusion, heat conduction)
  *        there is a base cache storing the data required to compute the respective fluxes. Specializations of the overall

dumux/shallowwater/swe/model.hh

@@ -46,7 +46,10 @@
 
 namespace Dumux
 {
-
+/*!
+ * \ingroup SweModel
+ *
+ */
 template <class TypeTag>
 struct SweModelTraits
 {

test/shallowwater/swe/sweproblem.hh

@@ -18,7 +18,7 @@
  *****************************************************************************/
 /*!
  * \file
- * \ingroup SWE Tests
+ * \ingroup SweTests
  * \brief A  simple dam break test for the SWEs.
  */
 #ifndef DUMUX_SWE_TEST_PROBLEM_HH
@@ -76,8 +76,7 @@ SET_PROP(SweTestTypeTag, SpatialParams)
 
 
 /*!
- * \ingroup Shallow water equations model
- * \ingroup ImplicitTestProblems
+ * \ingroup SweTests
  *
  * \brief A simple dambreak test
  *