From: Simon Sticko <simon@sticko.se>
Date: Fri, 22 Apr 2022 11:52:05 +0000 (+0200)
Subject: Add a documentation note to the generate()-function.
X-Git-Tag: v9.4.0-rc1~309^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F13632%2Fhead;p=dealii.git

Add a documentation note to the generate()-function.
---

diff --git a/include/deal.II/non_matching/quadrature_generator.h b/include/deal.II/non_matching/quadrature_generator.h
index 833df1d6cd..c973f85074 100644
--- a/include/deal.II/non_matching/quadrature_generator.h
+++ b/include/deal.II/non_matching/quadrature_generator.h
@@ -510,6 +510,9 @@ namespace NonMatching
     /**
      * Construct immersed quadratures rules based on the discrete level
      * set vector over the incoming cell.
+     *
+     * @note The cell needs to belong to the same triangulation as the one
+     * associated with the DoFHandler passed to the constructor.
      */
     void
     generate(const typename Triangulation<dim>::active_cell_iterator &cell);
@@ -563,6 +566,9 @@ namespace NonMatching
     /**
      * Construct immersed quadratures rules based on the discrete level
      * set vector over the incoming face described by cell and face index.
+     *
+     * @note The cell needs to belong to the same triangulation as the one
+     * associated with the DoFHandler passed to the constructor.
      */
     void
     generate(const typename Triangulation<dim>::active_cell_iterator &cell,