From a66dd87d89d4ece40df55cd8d5524aecd0f914b1 Mon Sep 17 00:00:00 2001 From: Timo Heister Date: Fri, 7 Sep 2018 11:45:06 -0400 Subject: [PATCH] quadrature: improve documentation --- include/deal.II/base/quadrature.h | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) 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>, + * const std::array, dim> &>::type + * @endcode + * The type is abbreviated in the online documentation to improve + * readability of this page. */ +#ifndef DOXYGEN typename std::conditional, dim>, const std::array, dim> &>::type +#else + const std::array, dim> & +#endif get_tensor_basis() const; protected: -- 2.39.5