From cbda5d954405fe09bdb4bb613c6225e8684ec385 Mon Sep 17 00:00:00 2001 From: Timo Heister Date: Tue, 21 Feb 2023 21:41:49 -0500 Subject: [PATCH] simplex doxygen: more cleanup - @brief is somehow output twice, so let's get rid of the annotation - use @section correctly - fix another @relates --- doc/doxygen/headers/simplex.h | 4 ++-- include/deal.II/grid/grid_generator.h | 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/doxygen/headers/simplex.h b/doc/doxygen/headers/simplex.h index 5beaf1d9b5..e71f5e7402 100644 --- a/doc/doxygen/headers/simplex.h +++ b/doc/doxygen/headers/simplex.h @@ -17,14 +17,14 @@ /** * @defgroup simplex Simplex support (experimental) * - * @brief This module describes the experimental simplex support in deal.II. + * This module describes the experimental simplex support in deal.II. * * Simplex and mixed meshes in deal.II are still experimental, i.e., work * in progress. Large parts of the library have been ported to be able to * operate on such kind of meshes. However, there are still many functions * that need to be generalized. * - * @section Important Simplex Functionality + * @section simplex_functionality_list Important Simplex Functionality * * Here is an incomplete list of functionality related to simplex * computations: diff --git a/include/deal.II/grid/grid_generator.h b/include/deal.II/grid/grid_generator.h index 969a873f61..4768bcaab2 100644 --- a/include/deal.II/grid/grid_generator.h +++ b/include/deal.II/grid/grid_generator.h @@ -1792,7 +1792,8 @@ namespace GridGenerator * * @image html grid_generator_implicit_function_3d.png * - * @relates simplex + * Also see + * @ref simplex "Simplex support". * * @param[out] tria The output triangulation * @param[in] implicit_function The implicit function -- 2.39.5