From 9e7245358e5ecee2c074193ecc04ddb852ad51e1 Mon Sep 17 00:00:00 2001 From: David Wells Date: Sun, 16 May 2021 12:22:23 -0400 Subject: [PATCH] Fix some simple doxygen warnings. --- include/deal.II/base/parameter_handler.h | 2 +- include/deal.II/differentiation/sd/symengine_types.h | 12 +++++------- include/deal.II/fe/fe_system.h | 6 +++--- 3 files changed, 9 insertions(+), 11 deletions(-) diff --git a/include/deal.II/base/parameter_handler.h b/include/deal.II/base/parameter_handler.h index 1e2c93f1fc..4d0bb9b94b 100644 --- a/include/deal.II/base/parameter_handler.h +++ b/include/deal.II/base/parameter_handler.h @@ -1344,7 +1344,7 @@ public: /** * Same as above, but an overload where the second argument is a character * pointer. This is necessary, since otherwise the call to - * set("abc","def") will be mapped to the function taking one + * set("abc","def") will be mapped to the function taking one * string and a bool as arguments, which is certainly not what is most often * intended. * diff --git a/include/deal.II/differentiation/sd/symengine_types.h b/include/deal.II/differentiation/sd/symengine_types.h index 0eb36f3af2..1247df71f1 100644 --- a/include/deal.II/differentiation/sd/symengine_types.h +++ b/include/deal.II/differentiation/sd/symengine_types.h @@ -53,10 +53,9 @@ namespace Differentiation /** * Type definition for a value substitution map. * - * This serves the same purpose as a - * SymEngine::map_basic_basic, which is equivalent to a - * std::map, - * SymEngine::RCP>. + * This serves the same purpose as a `SymEngine::map_basic_basic`, which + * is equivalent to a `std::map, + * SymEngine::RCP>`. */ using substitution_map = std::map; @@ -64,9 +63,8 @@ namespace Differentiation /** * Type definition for a vector of symbols. * - * This serves the same purpose as a SymEngine::vec_basic, - * which is equivalent to a std::vector> + * This serves the same purpose as a `SymEngine::vec_basic`, which is + * equivalent to a `std::vector>`. */ using symbol_vector = std::vector; diff --git a/include/deal.II/fe/fe_system.h b/include/deal.II/fe/fe_system.h index 259098e443..70cc620940 100644 --- a/include/deal.II/fe/fe_system.h +++ b/include/deal.II/fe/fe_system.h @@ -810,9 +810,9 @@ public: * here. * * The matrix @p P is the concatenation or the sum of the cell matrices @p - * P_i, depending on the #restriction_is_additive_flags. This distinguishes - * interpolation (concatenation) and projection with respect to scalar - * products (summation). + * P_i, depending on the value of FiniteElement::restriction_is_additive(). + * This distinguishes interpolation (concatenation) and projection with + * respect to scalar products (summation). * * Row and column indices are related to coarse grid and fine grid spaces, * respectively, consistent with the definition of the associated operator. -- 2.39.5