From: Timo Heister <timo.heister@gmail.com>
Date: Fri, 7 Sep 2018 15:45:06 +0000 (-0400)
Subject: quadrature: improve documentation
X-Git-Tag: v9.1.0-rc1~741^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F7160%2Fhead;p=dealii.git

quadrature: improve documentation
---

diff --git a/include/deal.II/base/quadrature.h b/include/deal.II/base/quadrature.h
index 25a919674f..dd7618dd85 100644
--- a/include/deal.II/base/quadrature.h
+++ b/include/deal.II/base/quadrature.h
@@ -251,12 +251,29 @@ public:
 
   /**
    * In case the quadrature formula is a tensor product, this function
-   * returns the one-dimensional basis objects.
+   * returns the @p dim one-dimensional basis objects.
    * Otherwise, calling this function is not allowed.
+   *
+   * For @p dim equal to one, we can not return the std::array as a const
+   * reference and have to return it by value. In this case, the array
+   * will always contain a single element (@p this).
+   *
+   * @note The actual return type of this function is
+   * @code
+   * std::conditional<dim == 1,
+   *                  std::array<Quadrature<1>, dim>,
+   *                  const std::array<Quadrature<1>, dim> &>::type
+   * @endcode
+   * The type is abbreviated in the online documentation to improve
+   * readability of this page.
    */
+#ifndef DOXYGEN
   typename std::conditional<dim == 1,
                             std::array<Quadrature<1>, dim>,
                             const std::array<Quadrature<1>, dim> &>::type
+#else
+  const std::array<Quadrature<1>, dim> &
+#endif
   get_tensor_basis() const;
 
 protected: