From d111a6a851522e9c4cbd8512b3df6a9a918d6e42 Mon Sep 17 00:00:00 2001 From: David Wells Date: Fri, 11 Jun 2021 12:45:21 -0400 Subject: [PATCH] Shorten a long type in doxygen. --- include/deal.II/grid/grid_generator.h | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/include/deal.II/grid/grid_generator.h b/include/deal.II/grid/grid_generator.h index 90fca82336..0a8d29ce08 100644 --- a/include/deal.II/grid/grid_generator.h +++ b/include/deal.II/grid/grid_generator.h @@ -2367,6 +2367,24 @@ namespace GridGenerator * the surface mesh. If left at its default, i.e., if the set is empty, then * the function operates on all boundary faces. * + * To prevent printing a very long type in the doxygen documentation the + * actual return type of this function is + * + * @code + * std::map::cell_iterator, + * typename DoFHandler::face_iterator> + * @endcode + * + * when MeshType is DoFHandler and + * + * @code + * std::map::cell_iterator, + * typename Triangulation::face_iterator> + * @endcode + * + * when MeshType is Triangulation and and not the shorter stub + * provided here. + * * @return A map that for each cell of the surface mesh (key) returns an * iterator to the corresponding face of a cell of the volume mesh (value). * The keys include both active and non-active cells of the surface mesh. @@ -2389,13 +2407,18 @@ namespace GridGenerator * @note Since @p volume_mesh and @p surface_mesh have different spatial * dimensions no manifold objects are copied by this function: you must * attach new manifold objects to @p surface_mesh. + * */ template