From a7a552fb5f3706f9455b29bd71e24658ac601cbb Mon Sep 17 00:00:00 2001 From: Timo Heister Date: Wed, 1 Jun 2022 13:04:46 -0400 Subject: [PATCH] doxygen: don't use @ingroup simplex fixes #13509 --- include/deal.II/base/quadrature_lib.h | 6 +++--- include/deal.II/fe/fe_pyramid_p.h | 6 +++--- include/deal.II/fe/fe_simplex_p.h | 6 +++--- include/deal.II/fe/fe_wedge_p.h | 6 +++--- include/deal.II/fe/mapping_fe.h | 2 +- include/deal.II/grid/grid_generator.h | 6 +++--- include/deal.II/grid/grid_in.h | 8 ++++---- 7 files changed, 20 insertions(+), 20 deletions(-) diff --git a/include/deal.II/base/quadrature_lib.h b/include/deal.II/base/quadrature_lib.h index 4cb866f49b..bbf666ab47 100644 --- a/include/deal.II/base/quadrature_lib.h +++ b/include/deal.II/base/quadrature_lib.h @@ -814,8 +814,6 @@ public: * For 1D, the quadrature rule degenerates to a * `dealii::QGauss<1>(n_points_1D)`. * - * @ingroup simplex - * * @note The quadrature rules implemented by this class come from a variety of * sources, but all of them have positive quadrature weights. * @@ -823,6 +821,8 @@ public: * respect to the vertices - i.e., the locations of the mapped quadrature points * depends on the numbering of the cell vertices. If you need rules that are * independent of the vertex numbering then use QWitherdenVincentSimplex. + * + * @relates simplex */ template class QGaussSimplex : public QSimplex @@ -863,7 +863,7 @@ public: * @note Some rules (2D 2 odd and 3D 2 even) do not yet exist and instead a * higher-order rule is used in their place. * - * @ingroup simplex + * @relates simplex */ template class QWitherdenVincentSimplex : public QSimplex diff --git a/include/deal.II/fe/fe_pyramid_p.h b/include/deal.II/fe/fe_pyramid_p.h index 243a5c615e..456267c695 100644 --- a/include/deal.II/fe/fe_pyramid_p.h +++ b/include/deal.II/fe/fe_pyramid_p.h @@ -29,7 +29,7 @@ DEAL_II_NAMESPACE_OPEN * * @note Only implemented for 3D. * - * @ingroup simplex + * @relates simplex */ template class FE_PyramidPoly : public dealii::FE_Poly @@ -59,7 +59,7 @@ public: * @note Currently, only linear polynomials (degree=1) are implemented. See * also the documentation of ScalarLagrangePolynomialPyramid. * - * @ingroup simplex + * @relates simplex */ template class FE_PyramidP : public FE_PyramidPoly @@ -121,7 +121,7 @@ public: * @note Currently, only linear polynomials (degree=1) are implemented. See * also the documentation of ScalarLagrangePolynomialPyramid. * - * @ingroup simplex + * @relates simplex */ template class FE_PyramidDGP : public FE_PyramidPoly diff --git a/include/deal.II/fe/fe_simplex_p.h b/include/deal.II/fe/fe_simplex_p.h index e99e7b7a98..3bbadd90e4 100644 --- a/include/deal.II/fe/fe_simplex_p.h +++ b/include/deal.II/fe/fe_simplex_p.h @@ -29,7 +29,7 @@ DEAL_II_NAMESPACE_OPEN * * @note Only implemented for 2D and 3D. * - * @ingroup simplex + * @relates simplex */ template class FE_SimplexPoly : public dealii::FE_Poly @@ -120,7 +120,7 @@ protected: * the finite element space of continuous, piecewise polynomials of * degree $k$. * - * @ingroup simplex + * @relates simplex */ template class FE_SimplexP : public FE_SimplexPoly @@ -175,7 +175,7 @@ public: * element space of discontinuous, piecewise polynomials of degree * $k$. * - * @ingroup simplex + * @relates simplex */ template class FE_SimplexDGP : public FE_SimplexPoly diff --git a/include/deal.II/fe/fe_wedge_p.h b/include/deal.II/fe/fe_wedge_p.h index 18d3227c19..b9b90d6a27 100644 --- a/include/deal.II/fe/fe_wedge_p.h +++ b/include/deal.II/fe/fe_wedge_p.h @@ -29,7 +29,7 @@ DEAL_II_NAMESPACE_OPEN * * @note Only implemented for 3D. * - * @ingroup simplex + * @relates simplex */ template class FE_WedgePoly : public dealii::FE_Poly @@ -60,7 +60,7 @@ public: * (degree=2) are implemented. See also the documentation of * ScalarLagrangePolynomialWedge. * - * @ingroup simplex + * @relates simplex */ template class FE_WedgeP : public FE_WedgePoly @@ -123,7 +123,7 @@ public: * (degree=2) are implemented. See also the documentation of * ScalarLagrangePolynomialWedge. * - * @ingroup simplex + * @relates simplex */ template class FE_WedgeDGP : public FE_WedgePoly diff --git a/include/deal.II/fe/mapping_fe.h b/include/deal.II/fe/mapping_fe.h index 2fba288dd5..529d75e548 100644 --- a/include/deal.II/fe/mapping_fe.h +++ b/include/deal.II/fe/mapping_fe.h @@ -52,7 +52,7 @@ DEAL_II_NAMESPACE_OPEN * @note Currently, only implemented for elements with tensor_degree==1 and * n_components==1. * - * @ingroup simplex + * @relates simplex */ template class MappingFE : public Mapping diff --git a/include/deal.II/grid/grid_generator.h b/include/deal.II/grid/grid_generator.h index d93d88e0ec..cce757f44a 100644 --- a/include/deal.II/grid/grid_generator.h +++ b/include/deal.II/grid/grid_generator.h @@ -2183,7 +2183,7 @@ namespace GridGenerator * out_tria.set_manifold(i, in_tria.get_manifold(i)); * @endcode * - * @ingroup simplex + * @relates simplex */ template void @@ -2399,7 +2399,7 @@ namespace GridGenerator * * @note Currently, this function only works for `dim==spacedim`. * - * @ingroup simplex + * @relates simplex */ template void @@ -2422,7 +2422,7 @@ namespace GridGenerator * quadrilateral/hexahedral cells and subdivides these into 2/5 * triangular/tetrahedral cells. * - * @ingroup simplex + * @relates simplex */ template void diff --git a/include/deal.II/grid/grid_in.h b/include/deal.II/grid/grid_in.h index 2832fec37b..7e74bdc2cd 100644 --- a/include/deal.II/grid/grid_in.h +++ b/include/deal.II/grid/grid_in.h @@ -411,7 +411,7 @@ public: * The companion GridOut::write_vtk function can be used to write VTK files * compatible with this method. * - * @ingroup simplex + * @relates simplex */ void read_vtk(std::istream &in); @@ -516,7 +516,7 @@ public: * Read grid data from an msh file. The %Gmsh formats are documented at * http://www.gmsh.info/. * - * @ingroup simplex + * @relates simplex */ void read_msh(std::istream &in); @@ -575,7 +575,7 @@ public: * as a boundary or material id. Physical surface numbers created in Gmsh, * which can be seen in the .geo file, become material IDs. * - * @ingroup simplex + * @relates simplex */ void read_msh(const std::string &filename); @@ -614,7 +614,7 @@ public: * @image html "comsol-mesh-boundary-lines.png" * @image html "comsol-mesh-boundary-triangles.png" * - * @ingroup simplex + * @relates simplex */ void read_comsol_mphtxt(std::istream &in); -- 2.39.5