From 9322b61fe6757d8fac67149b0507b9623eef150c Mon Sep 17 00:00:00 2001 From: Timo Heister Date: Mon, 6 Jul 2020 19:20:11 -0400 Subject: [PATCH] hide instantiations in Utilities from doxygen If you look at https://www.dealii.org/developer/doxygen/deal.II/namespaceUtilities_1_1MPI.html you see several pages of instantiations of sum/min/max/etc. without documentation. Similary, Utilities contains pack_integers, inverse_Hilbert_space_filling_curve, and other instantiations. Hide these from doxygen. --- source/base/mpi.inst.in | 7 +++++-- source/base/utilities.cc | 2 ++ 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/source/base/mpi.inst.in b/source/base/mpi.inst.in index de41fa2907..9e1de666fe 100644 --- a/source/base/mpi.inst.in +++ b/source/base/mpi.inst.in @@ -14,6 +14,8 @@ // --------------------------------------------------------------------- +#ifndef DOXYGEN + for (S : REAL_SCALARS) { template void sum(const SparseMatrix &, @@ -65,7 +67,6 @@ for (S : MPI_SCALARS) const MPI_Comm &, const ArrayView &); -#ifndef DOXYGEN // The fixed-length array (i.e., things declared like T(&values)[N]) // versions of the functions above live in the header file mpi.h since the // length (N) is a compile-time constant. Those functions all call @@ -85,7 +86,6 @@ for (S : MPI_SCALARS) const ArrayView &, const MPI_Comm &, const ArrayView &); -#endif } @@ -105,3 +105,6 @@ for (S : REAL_SCALARS; dim : SPACE_DIMENSIONS) template SymmetricTensor<4, dim, S> sum<4, dim, S>( const SymmetricTensor<4, dim, S> &, const MPI_Comm &); } + + +#endif diff --git a/source/base/utilities.cc b/source/base/utilities.cc index 00276c377c..1de6dc892f 100644 --- a/source/base/utilities.cc +++ b/source/base/utilities.cc @@ -1217,6 +1217,7 @@ namespace Utilities #endif +#ifndef DOXYGEN template std::string to_string(int, unsigned int); template std::string @@ -1273,6 +1274,7 @@ namespace Utilities template std::uint64_t pack_integers<3>(const std::array &, const int); +#endif } // namespace Utilities -- 2.39.5