]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Fix doxygen warnings
authorDaniel Arndt <arndtd@ornl.gov>
Thu, 8 Oct 2020 18:23:08 +0000 (14:23 -0400)
committerDaniel Arndt <arndtd@ornl.gov>
Thu, 8 Oct 2020 20:16:00 +0000 (16:16 -0400)
include/deal.II/fe/fe_poly.h
include/deal.II/fe/fe_poly_face.h
include/deal.II/fe/fe_poly_tensor.h
include/deal.II/fe/mapping_fe.h
include/deal.II/matrix_free/evaluation_kernels.h
include/deal.II/particles/particle.h
include/deal.II/particles/particle_accessor.h
include/deal.II/simplex/polynomials.h

index 94e63ba164f01536bd9d89703e85f9b3bbac4aff..4acb9184b339effb18d0b440bac8293dd5565d21 100644 (file)
@@ -253,13 +253,15 @@ protected:
   virtual std::unique_ptr<
     typename FiniteElement<dim, spacedim>::InternalDataBase>
   get_data(
-    const UpdateFlags update_flags,
-    const Mapping<dim, spacedim> & /*mapping*/,
-    const Quadrature<dim> &quadrature,
+    const UpdateFlags             update_flags,
+    const Mapping<dim, spacedim> &mapping,
+    const Quadrature<dim> &       quadrature,
     dealii::internal::FEValuesImplementation::FiniteElementRelatedData<dim,
                                                                        spacedim>
       &output_data) const override
   {
+    (void)mapping;
+
     // generate a new data object and
     // initialize some fields
     std::unique_ptr<typename FiniteElement<dim, spacedim>::InternalDataBase>
index cd2be76ff14fe91759186ed4a1eca6ddc6aaae13..f8d9695a3a0ba6d7e31cd1e601898969b574f974 100644 (file)
@@ -88,25 +88,31 @@ protected:
   virtual std::unique_ptr<
     typename FiniteElement<dim, spacedim>::InternalDataBase>
   get_data(
-    const UpdateFlags /*update_flags*/,
-    const Mapping<dim, spacedim> & /*mapping*/,
-    const Quadrature<dim> & /*quadrature*/,
+    const UpdateFlags             update_flags,
+    const Mapping<dim, spacedim> &mapping,
+    const Quadrature<dim> &       quadrature,
     dealii::internal::FEValuesImplementation::FiniteElementRelatedData<dim,
                                                                        spacedim>
-      & /*output_data*/) const override
+      &output_data) const override
   {
+    (void)update_flags;
+    (void)mapping;
+    (void)quadrature;
+    (void)output_data;
     return std::make_unique<InternalData>();
   }
 
   std::unique_ptr<typename FiniteElement<dim, spacedim>::InternalDataBase>
   get_face_data(
-    const UpdateFlags update_flags,
-    const Mapping<dim, spacedim> & /*mapping*/,
-    const Quadrature<dim - 1> &quadrature,
+    const UpdateFlags             update_flags,
+    const Mapping<dim, spacedim> &mapping,
+    const Quadrature<dim - 1> &   quadrature,
     dealii::internal::FEValuesImplementation::FiniteElementRelatedData<dim,
                                                                        spacedim>
-      & /*output_data*/) const override
+      &output_data) const override
   {
+    (void)mapping;
+    (void)output_data;
     // generate a new data object and
     // initialize some fields
     std::unique_ptr<typename FiniteElement<dim, spacedim>::InternalDataBase>
index 914e1ec089446bb5e9e22270938c23da209cab01..d12c4c914560f5b74c26ec7318ccd0801402d0ef 100644 (file)
@@ -236,13 +236,15 @@ protected:
   virtual std::unique_ptr<
     typename FiniteElement<dim, spacedim>::InternalDataBase>
   get_data(
-    const UpdateFlags update_flags,
-    const Mapping<dim, spacedim> & /*mapping*/,
-    const Quadrature<dim> &quadrature,
+    const UpdateFlags             update_flags,
+    const Mapping<dim, spacedim> &mapping,
+    const Quadrature<dim> &       quadrature,
     dealii::internal::FEValuesImplementation::FiniteElementRelatedData<dim,
                                                                        spacedim>
-      & /*output_data*/) const override
+      &output_data) const override
   {
+    (void)mapping;
+    (void)output_data;
     // generate a new data object and
     // initialize some fields
     std::unique_ptr<typename FiniteElement<dim, spacedim>::InternalDataBase>
index aa96493fcb8e6161c51ce8c8ff7dd81697ebdb0d..fb26cd76da6b75741f5526f561e718e83675efa1 100644 (file)
@@ -49,7 +49,7 @@ DEAL_II_NAMESPACE_OPEN
  * equivalent to MappingQGeneric(degree). Please note that no optimizations
  * exploiting tensor-product structures of finite elements have been added here.
  *
- * @node Currently, only implemented for elements with tensor_degree==1 and
+ * @note Currently, only implemented for elements with tensor_degree==1 and
  *   n_components==1.
  *
  * @ingroup simplex
index 5748e4f3757e15d4a2ebd60f27479044be215c3e..5b80b6d82f1ceeb617a05554283c7a7078cb1afe 100644 (file)
@@ -667,6 +667,7 @@ namespace internal
      * coefficient array, generating values along the columns of the
      * coefficient array.
      *
+     * @param n_components The number of vector components.
      * @param transformation_matrix The coefficient matrix handed in as a
      *                     vector, using @p basis_size_1 rows and @p basis_size_2
      *                     columns if interpreted as a matrix.
@@ -782,6 +783,7 @@ namespace internal
      * coefficient array, generating values along the rows of the coefficient
      * array.
      *
+     * @param n_components The number of vector components.
      * @param transformation_matrix The coefficient matrix handed in as a
      *                     vector, using @p basis_size_1 rows and @p basis_size_2
      *                     columns if interpreted as a matrix.
@@ -944,16 +946,17 @@ namespace internal
      * do_forward() operation, multiplication by the coefficients in the
      * quadrature points, and the do_backward() operation.
      *
+     * @param n_components The number of vector components.
      * @param transformation_matrix The coefficient matrix handed in as a
      *                     vector, using @p basis_size_1 rows and @p basis_size_2
      *                     columns if interpreted as a matrix.
      * @param coefficients The array of coefficients by which the result is
      *                     multiplied. Its length must be either
-     *                     basis_size_2^dim or n_components*basis_size_2^dim
+     *                     basis_size_2^dim or n_components*basis_size_2^dim.
      * @param values_in    The array of the input of size basis_size_2^dim. It
-     *                     may alias with values_out
+     *                     may alias with values_out.
      * @param scratch_data Array to hold temporary data during the operation.
-     *                     Must be of length basis_size_2^dim
+     *                     Must be of length basis_size_2^dim.
      * @param values_out   The array of size basis_size_1^dim where the results
      *                     of the transformation are stored. It may alias with
      *                     the values_in array.
index 0cf7d050efe6259fd2c0eccbe904630d0374e33b..81b31978270c44a0c2ba83198743ce89e37049f4 100644 (file)
@@ -246,7 +246,7 @@ namespace Particles
      *   particles on the latter are *copies* of particles owned on other
      *   processors, and should therefore be treated in the same way as
      *   ghost entries in @ref GlossGhostedVector "vectors with ghost elements"
-     *   or @ref GlossGhostCells "ghost cells": In both cases, one should
+     *   or @ref GlossGhostCell "ghost cells": In both cases, one should
      *   treat the ghost elements or cells as `const` objects that shouldn't
      *   be modified even if the objects allow for calls that modify
      *   properties. Rather, properties should only be modified on processors
@@ -274,7 +274,7 @@ namespace Particles
      *   particles on the latter are *copies* of particles owned on other
      *   processors, and should therefore be treated in the same way as
      *   ghost entries in @ref GlossGhostedVector "vectors with ghost elements"
-     *   or @ref GlossGhostCells "ghost cells": In both cases, one should
+     *   or @ref GlossGhostCell "ghost cells": In both cases, one should
      *   treat the ghost elements or cells as `const` objects that shouldn't
      *   be modified even if the objects allow for calls that modify
      *   properties. Rather, properties should only be modified on processors
@@ -319,7 +319,7 @@ namespace Particles
      *   particles on the latter are *copies* of particles owned on other
      *   processors, and should therefore be treated in the same way as
      *   ghost entries in @ref GlossGhostedVector "vectors with ghost elements"
-     *   or @ref GlossGhostCells "ghost cells": In both cases, one should
+     *   or @ref GlossGhostCell "ghost cells": In both cases, one should
      *   treat the ghost elements or cells as `const` objects that shouldn't
      *   be modified even if the objects allow for calls that modify
      *   properties. Rather, properties should only be modified on processors
@@ -356,7 +356,7 @@ namespace Particles
      *   particles on the latter are *copies* of particles owned on other
      *   processors, and should therefore be treated in the same way as
      *   ghost entries in @ref GlossGhostedVector "vectors with ghost elements"
-     *   or @ref GlossGhostCells "ghost cells": In both cases, one should
+     *   or @ref GlossGhostCell "ghost cells": In both cases, one should
      *   treat the ghost elements or cells as `const` objects that shouldn't
      *   be modified even if the objects allow for calls that modify
      *   properties. Rather, properties should only be modified on processors
index 2265d10af023e3d2f668de7b91a9b70d6233ed14..c3083bfbde0cf043dd4c2d30cf343fb4c2dfc631 100644 (file)
@@ -70,7 +70,7 @@ namespace Particles
      *   particles on the latter are *copies* of particles owned on other
      *   processors, and should therefore be treated in the same way as
      *   ghost entries in @ref GlossGhostedVector "vectors with ghost elements"
-     *   or @ref GlossGhostCells "ghost cells": In both cases, one should
+     *   or @ref GlossGhostCell "ghost cells": In both cases, one should
      *   treat the ghost elements or cells as `const` objects that shouldn't
      *   be modified even if the objects allow for calls that modify
      *   properties. Rather, properties should only be modified on processors
@@ -98,7 +98,7 @@ namespace Particles
      *   particles on the latter are *copies* of particles owned on other
      *   processors, and should therefore be treated in the same way as
      *   ghost entries in @ref GlossGhostedVector "vectors with ghost elements"
-     *   or @ref GlossGhostCells "ghost cells": In both cases, one should
+     *   or @ref GlossGhostCell "ghost cells": In both cases, one should
      *   treat the ghost elements or cells as `const` objects that shouldn't
      *   be modified even if the objects allow for calls that modify
      *   properties. Rather, properties should only be modified on processors
@@ -147,7 +147,7 @@ namespace Particles
      *   particles on the latter are *copies* of particles owned on other
      *   processors, and should therefore be treated in the same way as
      *   ghost entries in @ref GlossGhostedVector "vectors with ghost elements"
-     *   or @ref GlossGhostCells "ghost cells": In both cases, one should
+     *   or @ref GlossGhostCell "ghost cells": In both cases, one should
      *   treat the ghost elements or cells as `const` objects that shouldn't
      *   be modified even if the objects allow for calls that modify
      *   properties. Rather, properties should only be modified on processors
@@ -167,7 +167,7 @@ namespace Particles
      *   particles on the latter are *copies* of particles owned on other
      *   processors, and should therefore be treated in the same way as
      *   ghost entries in @ref GlossGhostedVector "vectors with ghost elements"
-     *   or @ref GlossGhostCells "ghost cells": In both cases, one should
+     *   or @ref GlossGhostCell "ghost cells": In both cases, one should
      *   treat the ghost elements or cells as `const` objects that shouldn't
      *   be modified even if the objects allow for calls that modify
      *   properties. Rather, properties should only be modified on processors
index 02f62ba434664164366d6d3cb5a64bfa5ddfec3e..7561d28a3afb43227ee6bf8b6c60eb96764f5f3d 100644 (file)
@@ -57,7 +57,7 @@ namespace Simplex
     /**
      * @copydoc ScalarPolynomialsBase::evaluate()
      *
-     * @note Currently, only the vectors @p values and @grads are filled.
+     * @note Currently, only the vectors @p values and @grads are filled.
      */
     void
     evaluate(const Point<dim> &           unit_point,

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.