From: Simon Sticko <simon@sticko.se>
Date: Thu, 28 Nov 2019 10:06:19 +0000 (+0100)
Subject: Add note on template parameter to GridTools::get_active_neighbors.
X-Git-Tag: v9.2.0-rc1~842^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F9108%2Fhead;p=dealii.git

Add note on template parameter to GridTools::get_active_neighbors.
---

diff --git a/include/deal.II/grid/grid_tools.h b/include/deal.II/grid/grid_tools.h
index 6d5b276837..175c0b55b1 100644
--- a/include/deal.II/grid/grid_tools.h
+++ b/include/deal.II/grid/grid_tools.h
@@ -1392,6 +1392,13 @@ namespace GridTools
    * @param[in] cell An iterator pointing to a cell of the mesh.
    * @param[out] active_neighbors A list of active descendants of the given
    * cell
+   *
+   * @note Since in C++ the MeshType template argument can not be deduced from
+   * a function call, you will have to specify it after the function name, as
+   * for example in
+   * @code
+   *   GridTools::get_active_neighbors<DoFHandler<dim>>(cell, active_neighbors)
+   * @endcode
    */
   template <class MeshType>
   void