From: Daniel Arndt <6da@ornl.gov> Date: Mon, 17 Oct 2022 18:37:59 +0000 (-0400) Subject: Fix a couple doxygen issues X-Git-Tag: v9.5.0-rc1~875^2~6 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7842145a430aa0821eda6088031bbaa05010ef22;p=dealii.git Fix a couple doxygen issues --- diff --git a/include/deal.II/base/point.h b/include/deal.II/base/point.h index ef73d94bd2..cf9cefa168 100644 --- a/include/deal.II/base/point.h +++ b/include/deal.II/base/point.h @@ -645,7 +645,6 @@ Point::serialize(Archive &ar, const unsigned int) * @note This function can also be used in CUDA device code. * * @relates Point - * @relatesalso EnableIfScalar */ template inline DEAL_II_CUDA_HOST_DEV diff --git a/include/deal.II/base/symmetric_tensor.h b/include/deal.II/base/symmetric_tensor.h index 9a95ff3fa4..e9d01c5cde 100644 --- a/include/deal.II/base/symmetric_tensor.h +++ b/include/deal.II/base/symmetric_tensor.h @@ -3574,7 +3574,6 @@ operator*(const Number &factor, const SymmetricTensor &t) * input tensor by the scalar factor. * * @relates SymmetricTensor - * @relatesalso EnableIfScalar */ template constexpr inline DEAL_II_ALWAYS_INLINE SymmetricTensor< @@ -3604,7 +3603,6 @@ operator*(const SymmetricTensor &t, * information about template arguments and the return type. * * @relates SymmetricTensor - * @relatesalso EnableIfScalar */ template constexpr inline DEAL_II_ALWAYS_INLINE SymmetricTensor< @@ -3719,7 +3717,6 @@ scalar_product(const SymmetricTensor<2, dim, Number> & t1, * A*B (instead of scalar_product(A,B)) provides * $(\mathbf A \cdot\mathbf B)_{ij}=\sum_k A_{ik}B_{kj}$. * - * @relatesalso Tensor * @relates SymmetricTensor */ template @@ -3747,7 +3744,6 @@ constexpr inline DEAL_II_ALWAYS_INLINE * A*B (instead of scalar_product(A,B)) provides * $(\mathbf A \cdot\mathbf B)_{ij}=\sum_k A_{ik}B_{kj}$. * - * @relatesalso Tensor * @relates SymmetricTensor */ template diff --git a/include/deal.II/base/tensor.h b/include/deal.II/base/tensor.h index 8bb4f15da5..4ce5235517 100644 --- a/include/deal.II/base/tensor.h +++ b/include/deal.II/base/tensor.h @@ -1931,7 +1931,9 @@ operator<<(std::ostream &out, const Tensor<0, dim, Number> &p) } -/** @} */ +/** + * @} + */ /** * @name Vector space operations on Tensor objects: * @{ @@ -2271,7 +2273,9 @@ inline constexpr DEAL_II_ALWAYS_INLINE return tmp; } -/** @} */ +/** + * @} + */ /** * @name Contraction operations and the outer product for tensor objects * @{ @@ -2613,7 +2617,9 @@ constexpr inline DEAL_II_ALWAYS_INLINE } -/** @} */ +/** + * @} + */ /** * @name Special operations on tensors of rank 1 * @{ diff --git a/include/deal.II/lac/block_linear_operator.h b/include/deal.II/lac/block_linear_operator.h index 7ffdbea54a..7e9add04f2 100644 --- a/include/deal.II/lac/block_linear_operator.h +++ b/include/deal.II/lac/block_linear_operator.h @@ -835,7 +835,6 @@ block_diagonal_operator( /** * @relatesalso LinearOperator - * @relatesalso BlockLinearOperator * * This function implements forward substitution to invert a lower block * triangular matrix. As arguments, it takes a BlockLinearOperator @p @@ -952,7 +951,6 @@ block_forward_substitution( /** - * @relatesalso LinearOperator * @relatesalso BlockLinearOperator * * This function implements back substitution to invert an upper block diff --git a/include/deal.II/lac/dynamic_sparsity_pattern.h b/include/deal.II/lac/dynamic_sparsity_pattern.h index adbb9edde4..f260aaa245 100644 --- a/include/deal.II/lac/dynamic_sparsity_pattern.h +++ b/include/deal.II/lac/dynamic_sparsity_pattern.h @@ -549,8 +549,8 @@ public: /** * @name Iterators + * @{ */ - // @{ /** * Iterator starting at the first entry of the matrix. The resulting @@ -604,7 +604,9 @@ public: iterator end(const size_type r) const; - /** @} */ + /** + * @} + */ /** * Compute the bandwidth of the matrix represented by this structure. The diff --git a/include/deal.II/meshworker/integration_info.h b/include/deal.II/meshworker/integration_info.h index d27b4518f9..035d261c08 100644 --- a/include/deal.II/meshworker/integration_info.h +++ b/include/deal.II/meshworker/integration_info.h @@ -349,8 +349,8 @@ namespace MeshWorker const BlockInfo * block_info = nullptr); /** * @name FEValues setup + * @{ */ - /* @{ */ /** * Call this function before initialize() in order to guess the update @@ -470,8 +470,8 @@ namespace MeshWorker /** * @name Data vectors + * @{ */ - /* @{ */ /** * Initialize the VectorSelector objects #cell_selector, @@ -507,8 +507,8 @@ namespace MeshWorker /** * @name Interface for MeshWorker::loop() + * @{ */ - /* @{ */ /** * A callback function which is called in the loop over all cells, after * the action on a cell has been performed and before the faces are dealt diff --git a/include/deal.II/physics/elasticity/standard_tensors.h b/include/deal.II/physics/elasticity/standard_tensors.h index 741191b08d..7facd3b6ea 100644 --- a/include/deal.II/physics/elasticity/standard_tensors.h +++ b/include/deal.II/physics/elasticity/standard_tensors.h @@ -40,7 +40,6 @@ namespace Physics * Cartesian basis, where the metric tensor is the identity tensor. * * @relatesalso Tensor - * @relatesalso SymmetricTensor */ template class StandardTensors