]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Match doxygen markup in the .cc file to that in the .h file. 6952/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Sun, 22 Jul 2018 15:45:50 +0000 (09:45 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Sun, 22 Jul 2018 15:45:50 +0000 (09:45 -0600)
This is necessary because we run both the .h and the .cc files through doxygen.
If we don't do this, then doxygen will show functions with different markup
twice in the online documentation.

source/grid/grid_tools.cc

index 188aafd91e3e02d3daef7db1c5fcc5aaf8f584df..248998f535ff1b5760d565b8f4bafc0bd4bc9718 100644 (file)
@@ -1860,9 +1860,13 @@ namespace GridTools
 
 
   template <int spacedim>
+#ifndef DOXYGEN
   std::tuple<std::vector<std::vector<unsigned int>>,
              std::map<unsigned int, unsigned int>,
              std::map<unsigned int, std::vector<unsigned int>>>
+#else
+  return_type
+#endif
   guess_point_owner(
     const std::vector<std::vector<BoundingBox<spacedim>>> &global_bboxes,
     const std::vector<Point<spacedim>> &                   points)
@@ -3987,10 +3991,14 @@ namespace GridTools
 
 
   template <int dim, int spacedim>
+#ifndef DOXYGEN
   std::tuple<
     std::vector<typename Triangulation<dim, spacedim>::active_cell_iterator>,
     std::vector<std::vector<Point<dim>>>,
     std::vector<std::vector<unsigned int>>>
+#else
+  return_type
+#endif
   compute_point_locations(
     const Cache<dim, spacedim> &        cache,
     const std::vector<Point<spacedim>> &points,
@@ -4488,12 +4496,16 @@ namespace GridTools
 
 
   template <int dim, int spacedim>
+#ifndef DOXYGEN
   std::tuple<
     std::vector<typename Triangulation<dim, spacedim>::active_cell_iterator>,
     std::vector<std::vector<Point<dim>>>,
     std::vector<std::vector<unsigned int>>,
     std::vector<std::vector<Point<spacedim>>>,
     std::vector<std::vector<unsigned int>>>
+#else
+  return_type
+#endif
   distributed_compute_point_locations(
     const GridTools::Cache<dim, spacedim> &                cache,
     const std::vector<Point<spacedim>> &                   local_points,

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.