From cbd55eda91374994d539850cd17819802268924a Mon Sep 17 00:00:00 2001 From: Daniel Arndt Date: Thu, 21 May 2020 12:05:26 -0400 Subject: [PATCH] Fix documentation --- include/deal.II/base/polynomial_space.h | 2 +- include/deal.II/base/polynomials_abf.h | 2 +- include/deal.II/base/polynomials_adini.h | 2 +- include/deal.II/base/polynomials_bdm.h | 2 +- include/deal.II/base/polynomials_bernardi_raugel.h | 2 +- include/deal.II/base/polynomials_nedelec.h | 2 +- include/deal.II/base/polynomials_rannacher_turek.h | 2 +- include/deal.II/base/polynomials_raviart_thomas.h | 2 +- include/deal.II/base/polynomials_rt_bubbles.h | 2 +- include/deal.II/base/scalar_polynomials_base.h | 8 ++++---- include/deal.II/base/tensor_product_polynomials.h | 4 ++-- include/deal.II/base/tensor_product_polynomials_bubbles.h | 2 +- include/deal.II/base/tensor_product_polynomials_const.h | 2 +- 13 files changed, 17 insertions(+), 17 deletions(-) diff --git a/include/deal.II/base/polynomial_space.h b/include/deal.II/base/polynomial_space.h index e1260dd53a..74fb9c98f0 100644 --- a/include/deal.II/base/polynomial_space.h +++ b/include/deal.II/base/polynomial_space.h @@ -233,7 +233,7 @@ public: name() const override; /** - * @copydoc ScalarPolynomialsBase::clone() + * @copydoc ScalarPolynomialsBase::clone() */ virtual std::unique_ptr> clone() const override; diff --git a/include/deal.II/base/polynomials_abf.h b/include/deal.II/base/polynomials_abf.h index b5c6dc6668..ac6950ad30 100644 --- a/include/deal.II/base/polynomials_abf.h +++ b/include/deal.II/base/polynomials_abf.h @@ -100,7 +100,7 @@ public: n_polynomials(const unsigned int degree); /** - * @copydoc TensorPolynomialsBase::clone() + * @copydoc TensorPolynomialsBase::clone() */ virtual std::unique_ptr> clone() const override; diff --git a/include/deal.II/base/polynomials_adini.h b/include/deal.II/base/polynomials_adini.h index 49eb1033f0..20f4fb6446 100644 --- a/include/deal.II/base/polynomials_adini.h +++ b/include/deal.II/base/polynomials_adini.h @@ -133,7 +133,7 @@ public: name() const override; /** - * @copydoc ScalarPolynomialsBase::clone() + * @copydoc ScalarPolynomialsBase::clone() */ virtual std::unique_ptr> clone() const override; diff --git a/include/deal.II/base/polynomials_bdm.h b/include/deal.II/base/polynomials_bdm.h index 7e4cd085a7..f2c041a80b 100644 --- a/include/deal.II/base/polynomials_bdm.h +++ b/include/deal.II/base/polynomials_bdm.h @@ -146,7 +146,7 @@ public: n_polynomials(const unsigned int degree); /** - * @copydoc TensorPolynomialsBase::clone() + * @copydoc TensorPolynomialsBase::clone() */ virtual std::unique_ptr> clone() const override; diff --git a/include/deal.II/base/polynomials_bernardi_raugel.h b/include/deal.II/base/polynomials_bernardi_raugel.h index 68daeb5c8a..d226b9e488 100644 --- a/include/deal.II/base/polynomials_bernardi_raugel.h +++ b/include/deal.II/base/polynomials_bernardi_raugel.h @@ -131,7 +131,7 @@ public: n_polynomials(const unsigned int k); /** - * @copydoc TensorPolynomialsBase::clone() + * @copydoc TensorPolynomialsBase::clone() */ virtual std::unique_ptr> clone() const override; diff --git a/include/deal.II/base/polynomials_nedelec.h b/include/deal.II/base/polynomials_nedelec.h index d1ed0fa854..99e4c59fd9 100644 --- a/include/deal.II/base/polynomials_nedelec.h +++ b/include/deal.II/base/polynomials_nedelec.h @@ -97,7 +97,7 @@ public: n_polynomials(const unsigned int degree); /** - * @copydoc TensorPolynomialsBase::clone() + * @copydoc TensorPolynomialsBase::clone() */ virtual std::unique_ptr> clone() const override; diff --git a/include/deal.II/base/polynomials_rannacher_turek.h b/include/deal.II/base/polynomials_rannacher_turek.h index b411c6e74c..47eb615ad8 100644 --- a/include/deal.II/base/polynomials_rannacher_turek.h +++ b/include/deal.II/base/polynomials_rannacher_turek.h @@ -130,7 +130,7 @@ public: name() const override; /** - * @copydoc ScalarPolynomialsBase::clone() + * @copydoc ScalarPolynomialsBase::clone() */ virtual std::unique_ptr> clone() const override; diff --git a/include/deal.II/base/polynomials_raviart_thomas.h b/include/deal.II/base/polynomials_raviart_thomas.h index a6bc0b5432..27d293eabe 100644 --- a/include/deal.II/base/polynomials_raviart_thomas.h +++ b/include/deal.II/base/polynomials_raviart_thomas.h @@ -95,7 +95,7 @@ public: n_polynomials(const unsigned int degree); /** - * @copydoc TensorPolynomialsBase::clone() + * @copydoc TensorPolynomialsBase::clone() */ virtual std::unique_ptr> clone() const override; diff --git a/include/deal.II/base/polynomials_rt_bubbles.h b/include/deal.II/base/polynomials_rt_bubbles.h index 83e5dacfc8..e7d9d64082 100644 --- a/include/deal.II/base/polynomials_rt_bubbles.h +++ b/include/deal.II/base/polynomials_rt_bubbles.h @@ -129,7 +129,7 @@ public: n_polynomials(const unsigned int degree); /** - * @copydoc TensorPolynomialsBase::clone() + * @copydoc TensorPolynomialsBase::clone() */ virtual std::unique_ptr> clone() const override; diff --git a/include/deal.II/base/scalar_polynomials_base.h b/include/deal.II/base/scalar_polynomials_base.h index bd56e81936..c039e4b7cb 100644 --- a/include/deal.II/base/scalar_polynomials_base.h +++ b/include/deal.II/base/scalar_polynomials_base.h @@ -110,7 +110,7 @@ public: * Compute the value of the ith polynomial at unit point * p. * - * Consider using compute() instead. + * Consider using evaluate() instead. */ virtual double compute_value(const unsigned int /*i*/, const Point & /*p*/) const = 0; @@ -119,7 +119,7 @@ public: * Compute the orderth derivative of the ith polynomial * at unit point p. * - * Consider using compute() instead. + * Consider using evaluate() instead. * * @tparam order The order of the derivative. */ @@ -167,7 +167,7 @@ public: * Compute the gradient of the ith polynomial at unit point * p. * - * Consider using compute() instead. + * Consider using evaluate() instead. */ virtual Tensor<1, dim> compute_grad(const unsigned int /*i*/, const Point & /*p*/) const = 0; @@ -176,7 +176,7 @@ public: * Compute the second derivative (grad_grad) of the ith polynomial * at unit point p. * - * Consider using compute() instead. + * Consider using evaluate() instead. */ virtual Tensor<2, dim> compute_grad_grad(const unsigned int /*i*/, diff --git a/include/deal.II/base/tensor_product_polynomials.h b/include/deal.II/base/tensor_product_polynomials.h index 653fbcbd8b..e857e325c3 100644 --- a/include/deal.II/base/tensor_product_polynomials.h +++ b/include/deal.II/base/tensor_product_polynomials.h @@ -232,7 +232,7 @@ public: name() const override; /** - * @copydoc ScalarPolynomialsBase::clone() + * @copydoc ScalarPolynomialsBase::clone() */ virtual std::unique_ptr> clone() const override; @@ -453,7 +453,7 @@ public: name() const override; /** - * @copydoc ScalarPolynomialsBase::clone() + * @copydoc ScalarPolynomialsBase::clone() */ virtual std::unique_ptr> clone() const override; diff --git a/include/deal.II/base/tensor_product_polynomials_bubbles.h b/include/deal.II/base/tensor_product_polynomials_bubbles.h index 59baa0366e..04a46f4a94 100644 --- a/include/deal.II/base/tensor_product_polynomials_bubbles.h +++ b/include/deal.II/base/tensor_product_polynomials_bubbles.h @@ -213,7 +213,7 @@ public: name() const override; /** - * @copydoc ScalarPolynomialsBase::clone() + * @copydoc ScalarPolynomialsBase::clone() */ virtual std::unique_ptr> clone() const override; diff --git a/include/deal.II/base/tensor_product_polynomials_const.h b/include/deal.II/base/tensor_product_polynomials_const.h index 274f247492..2391301d1a 100644 --- a/include/deal.II/base/tensor_product_polynomials_const.h +++ b/include/deal.II/base/tensor_product_polynomials_const.h @@ -214,7 +214,7 @@ public: name() const override; /** - * @copydoc ScalarPolynomialsBase::clone() + * @copydoc ScalarPolynomialsBase::clone() */ virtual std::unique_ptr> clone() const override; -- 2.39.5