]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Fix a couple doxygen issues
authorDaniel Arndt <6da@ornl.gov>
Mon, 17 Oct 2022 18:37:59 +0000 (14:37 -0400)
committerDaniel Arndt <6da@ornl.gov>
Mon, 17 Oct 2022 18:37:59 +0000 (14:37 -0400)
include/deal.II/base/point.h
include/deal.II/base/symmetric_tensor.h
include/deal.II/base/tensor.h
include/deal.II/lac/block_linear_operator.h
include/deal.II/lac/dynamic_sparsity_pattern.h
include/deal.II/meshworker/integration_info.h
include/deal.II/physics/elasticity/standard_tensors.h

index ef73d94bd2cdbb694cc42c58bde523f041f258f1..cf9cefa168fc405dce214b1c9956729502580a16 100644 (file)
@@ -645,7 +645,6 @@ Point<dim, Number>::serialize(Archive &ar, const unsigned int)
  * @note This function can also be used in CUDA device code.
  *
  * @relates Point
- * @relatesalso EnableIfScalar
  */
 template <int dim, typename Number, typename OtherNumber>
 inline DEAL_II_CUDA_HOST_DEV
index 9a95ff3fa463a21f99e3d136c3c572cffccf075c..e9d01c5cdeeb956939a15936ea48e9656f4b03eb 100644 (file)
@@ -3574,7 +3574,6 @@ operator*(const Number &factor, const SymmetricTensor<rank_, dim, Number> &t)
  * input tensor by the scalar factor.
  *
  * @relates SymmetricTensor
- * @relatesalso EnableIfScalar
  */
 template <int rank_, int dim, typename Number, typename OtherNumber>
 constexpr inline DEAL_II_ALWAYS_INLINE SymmetricTensor<
@@ -3604,7 +3603,6 @@ operator*(const SymmetricTensor<rank_, dim, Number> &t,
  * information about template arguments and the return type.
  *
  * @relates SymmetricTensor
- * @relatesalso EnableIfScalar
  */
 template <int rank_, int dim, typename Number, typename OtherNumber>
 constexpr inline DEAL_II_ALWAYS_INLINE SymmetricTensor<
@@ -3719,7 +3717,6 @@ scalar_product(const SymmetricTensor<2, dim, Number> &     t1,
  * <tt>A*B</tt> (instead of <tt>scalar_product(A,B)</tt>) provides
  * $(\mathbf A \cdot\mathbf B)_{ij}=\sum_k A_{ik}B_{kj}$.
  *
- * @relatesalso Tensor
  * @relates SymmetricTensor
  */
 template <int dim, typename Number, typename OtherNumber>
@@ -3747,7 +3744,6 @@ constexpr inline DEAL_II_ALWAYS_INLINE
  * <tt>A*B</tt> (instead of <tt>scalar_product(A,B)</tt>) provides
  * $(\mathbf A \cdot\mathbf B)_{ij}=\sum_k A_{ik}B_{kj}$.
  *
- * @relatesalso Tensor
  * @relates SymmetricTensor
  */
 template <int dim, typename Number, typename OtherNumber>
index 8bb4f15da5245ead6bbb8711754f64bb4a996bd3..4ce5235517e0bdb427760ce3dc83ac75d2052bfa 100644 (file)
@@ -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
  * @{
index 7ffdbea54ac83dc92daf23bc6700fbd0d4c10826..7e9add04f238f41439156bca5dd0899e4b5668d6 100644 (file)
@@ -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
index adbb9edde40f79c991135742278cceb6e2f1ddb3..f260aaa24575e90590e2384c646fc6849becf7c6 100644 (file)
@@ -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
index d27b4518f9ff95c30d3c2e703b8dc71ef5e4819f..035d261c085d4d5c1b8161184e084a7c83eab533 100644 (file)
@@ -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
index 741191b08d71a74909d396225018b82dd71bbe42..7facd3b6ead7054995abbd1288b4055ff82b0a46 100644 (file)
@@ -40,7 +40,6 @@ namespace Physics
      * Cartesian basis, where the metric tensor is the identity tensor.
      *
      * @relatesalso Tensor
-     * @relatesalso SymmetricTensor
      */
     template <int dim>
     class StandardTensors

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.