]> https://gitweb.dealii.org/ - dealii.git/commitdiff
simplex doxygen: more cleanup 14820/head
authorTimo Heister <timo.heister@gmail.com>
Wed, 22 Feb 2023 02:41:49 +0000 (21:41 -0500)
committerTimo Heister <timo.heister@gmail.com>
Wed, 22 Feb 2023 02:41:49 +0000 (21:41 -0500)
- @brief is somehow output twice, so let's get rid of the annotation
- use @section correctly
- fix another @relates

doc/doxygen/headers/simplex.h
include/deal.II/grid/grid_generator.h

index 5beaf1d9b57078e8bd650515dfa9c0f040305eed..e71f5e74026434bacbad5b6ab4404c1d7a0669fe 100644 (file)
 /**
  * @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:
index 969a873f618ca93785324b0cbeea4a92d8c25da4..4768bcaab2d540f7311f3330927092acf2ba29ba 100644 (file)
@@ -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

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.