From 8027cf7b4ca47725903ce600452bb2157c2f216e Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Wed, 5 Oct 2022 09:24:10 -0600 Subject: [PATCH] Fix some doxygen problems. --- include/deal.II/base/point.h | 2 +- include/deal.II/base/symmetric_tensor.h | 42 ++++++++++++------------- include/deal.II/base/tensor.h | 8 +++-- 3 files changed, 28 insertions(+), 24 deletions(-) diff --git a/include/deal.II/base/point.h b/include/deal.II/base/point.h index 980acdbda8..ef73d94bd2 100644 --- a/include/deal.II/base/point.h +++ b/include/deal.II/base/point.h @@ -644,7 +644,7 @@ Point::serialize(Archive &ar, const unsigned int) * * @note This function can also be used in CUDA device code. * - * @relatesalso Point + * @relates Point * @relatesalso EnableIfScalar */ template diff --git a/include/deal.II/base/symmetric_tensor.h b/include/deal.II/base/symmetric_tensor.h index 462ef41b70..9a95ff3fa4 100644 --- a/include/deal.II/base/symmetric_tensor.h +++ b/include/deal.II/base/symmetric_tensor.h @@ -3573,7 +3573,7 @@ operator*(const Number &factor, const SymmetricTensor &t) * the type you would get if you multiplied an individual component of the * input tensor by the scalar factor. * - * @relatesalso SymmetricTensor + * @relates SymmetricTensor * @relatesalso EnableIfScalar */ template @@ -3603,7 +3603,7 @@ operator*(const SymmetricTensor &t, * See the discussion with the operator with switched arguments for more * information about template arguments and the return type. * - * @relatesalso SymmetricTensor + * @relates SymmetricTensor * @relatesalso EnableIfScalar */ template @@ -3624,7 +3624,7 @@ operator*(const Number & factor, /** * Division of a symmetric tensor of general rank by a scalar. * - * @relatesalso SymmetricTensor + * @relates SymmetricTensor */ template constexpr inline SymmetricTensor< @@ -3647,7 +3647,7 @@ operator/(const SymmetricTensor &t, * Multiplication of a symmetric tensor of general rank with a scalar from the * right. * - * @relatesalso SymmetricTensor + * @relates SymmetricTensor */ template constexpr inline DEAL_II_ALWAYS_INLINE SymmetricTensor @@ -3664,7 +3664,7 @@ operator*(const SymmetricTensor &t, const double factor) * Multiplication of a symmetric tensor of general rank with a scalar from the * left. * - * @relatesalso SymmetricTensor + * @relates SymmetricTensor */ template constexpr inline DEAL_II_ALWAYS_INLINE SymmetricTensor @@ -3680,7 +3680,7 @@ operator*(const double factor, const SymmetricTensor &t) /** * Division of a symmetric tensor of general rank by a scalar. * - * @relatesalso SymmetricTensor + * @relates SymmetricTensor */ template constexpr inline SymmetricTensor @@ -3698,7 +3698,7 @@ operator/(const SymmetricTensor &t, const double factor) * the expression A*B which uses * SymmetricTensor::operator*(). * - * @relatesalso SymmetricTensor + * @relates SymmetricTensor */ template constexpr DEAL_II_ALWAYS_INLINE typename ProductType::type @@ -3720,7 +3720,7 @@ scalar_product(const SymmetricTensor<2, dim, Number> & t1, * $(\mathbf A \cdot\mathbf B)_{ij}=\sum_k A_{ik}B_{kj}$. * * @relatesalso Tensor - * @relatesalso SymmetricTensor + * @relates SymmetricTensor */ template constexpr inline DEAL_II_ALWAYS_INLINE @@ -3748,7 +3748,7 @@ constexpr inline DEAL_II_ALWAYS_INLINE * $(\mathbf A \cdot\mathbf B)_{ij}=\sum_k A_{ik}B_{kj}$. * * @relatesalso Tensor - * @relatesalso SymmetricTensor + * @relates SymmetricTensor */ template constexpr DEAL_II_ALWAYS_INLINE typename ProductType::type @@ -3771,7 +3771,7 @@ scalar_product(const Tensor<2, dim, Number> & t1, * magnitude faster. This function mostly exists for compatibility purposes * with the general Tensor class. * - * @relatesalso SymmetricTensor + * @relates SymmetricTensor */ template constexpr inline DEAL_II_ALWAYS_INLINE void @@ -3797,7 +3797,7 @@ double_contract( * magnitude faster. This function mostly exists for compatibility purposes * with the general Tensor class. * - * @relatesalso SymmetricTensor + * @relates SymmetricTensor */ template constexpr inline void @@ -3823,7 +3823,7 @@ double_contract( * magnitude faster. This function mostly exists for compatibility purposes * with the general Tensor class. * - * @relatesalso SymmetricTensor + * @relates SymmetricTensor */ template constexpr inline void @@ -3854,7 +3854,7 @@ double_contract( * magnitude faster. This function mostly exists for compatibility purposes * with the general Tensor class. * - * @relatesalso SymmetricTensor + * @relates SymmetricTensor */ template constexpr inline void @@ -3885,7 +3885,7 @@ double_contract( * magnitude faster. This function mostly exists for compatibility purposes * with the general Tensor class. * - * @relatesalso SymmetricTensor + * @relates SymmetricTensor */ template constexpr inline void @@ -3917,7 +3917,7 @@ double_contract( * magnitude faster. This function mostly exists for compatibility purposes * with the general Tensor class. * - * @relatesalso SymmetricTensor + * @relates SymmetricTensor */ template constexpr inline void @@ -3941,7 +3941,7 @@ double_contract( * Multiply a symmetric rank-2 tensor (i.e., a matrix) by a rank-1 tensor * (i.e., a vector). The result is a rank-1 tensor (i.e., a vector). * - * @relatesalso SymmetricTensor + * @relates SymmetricTensor */ template constexpr Tensor<1, dim, typename ProductType::type> @@ -3960,7 +3960,7 @@ operator*(const SymmetricTensor<2, dim, Number> &src1, * Multiply a rank-1 tensor (i.e., a vector) by a symmetric rank-2 tensor * (i.e., a matrix). The result is a rank-1 tensor (i.e., a vector). * - * @relatesalso SymmetricTensor + * @relates SymmetricTensor */ template constexpr Tensor<1, dim, typename ProductType::type> @@ -3990,7 +3990,7 @@ operator*(const Tensor<1, dim, Number> & src1, * multiplication operator for SymmetricTensor, which does the double * contraction. * - * @relatesalso SymmetricTensor + * @relates SymmetricTensor */ template inline std::ostream & @@ -4079,7 +4079,7 @@ operator<<(std::ostream &out, const SymmetricTensor<2, dim, Number> &t) * represents the symmetry in the output, for example by outputting only the * unique entries. * - * @relatesalso SymmetricTensor + * @relates SymmetricTensor */ template inline std::ostream & diff --git a/include/deal.II/base/tensor.h b/include/deal.II/base/tensor.h index 3eae1e72c6..8bb4f15da5 100644 --- a/include/deal.II/base/tensor.h +++ b/include/deal.II/base/tensor.h @@ -2676,7 +2676,9 @@ constexpr inline DEAL_II_ALWAYS_INLINE } -/** @} */ +/** + * @} + */ /** * @name Special operations on tensors of rank 2 * @{ @@ -3046,7 +3048,9 @@ linfty_norm(const Tensor<2, dim, Number> &t) return max; } -/** @} */ +/** + * @} + */ #ifndef DOXYGEN -- 2.39.5