]> https://gitweb.dealii.org/ - dealii.git/commitdiff
hide instantiations in Utilities from doxygen
authorTimo Heister <timo.heister@gmail.com>
Mon, 6 Jul 2020 23:20:11 +0000 (19:20 -0400)
committerTimo Heister <timo.heister@gmail.com>
Mon, 6 Jul 2020 23:20:45 +0000 (19:20 -0400)
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
source/base/utilities.cc

index de41fa2907af60c5efa0d81ca145b9f4074c7dcf..9e1de666fec55599a8ad88251989843e4b5ffbd0 100644 (file)
@@ -14,6 +14,8 @@
 // ---------------------------------------------------------------------
 
 
+#ifndef DOXYGEN
+
 for (S : REAL_SCALARS)
   {
     template void sum<S>(const SparseMatrix<S> &,
@@ -65,7 +67,6 @@ for (S : MPI_SCALARS)
                          const MPI_Comm &,
                          const ArrayView<S> &);
 
-#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 S> &,
       const MPI_Comm &,
       const ArrayView<S> &);
-#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
index 00276c377cbef252f5f8148f42c66004f2bd64c3..1de6dc892f06457891de04005c74badd1cbe4ded 100644 (file)
@@ -1217,6 +1217,7 @@ namespace Utilities
 
 #endif
 
+#ifndef DOXYGEN
   template std::string
   to_string<int>(int, unsigned int);
   template std::string
@@ -1273,6 +1274,7 @@ namespace Utilities
   template std::uint64_t
   pack_integers<3>(const std::array<std::uint64_t, 3> &, const int);
 
+#endif
 
 } // namespace Utilities
 

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.