From: Daniel Arndt Date: Thu, 8 Oct 2020 18:23:08 +0000 (-0400) Subject: Fix doxygen warnings X-Git-Tag: v9.3.0-rc1~1016^2~3 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f78acd00b4850e1f8d70c5e1aba3f9f954f47a0a;p=dealii.git Fix doxygen warnings --- diff --git a/include/deal.II/fe/fe_poly.h b/include/deal.II/fe/fe_poly.h index 94e63ba164..4acb9184b3 100644 --- a/include/deal.II/fe/fe_poly.h +++ b/include/deal.II/fe/fe_poly.h @@ -253,13 +253,15 @@ protected: virtual std::unique_ptr< typename FiniteElement::InternalDataBase> get_data( - const UpdateFlags update_flags, - const Mapping & /*mapping*/, - const Quadrature &quadrature, + const UpdateFlags update_flags, + const Mapping &mapping, + const Quadrature & quadrature, dealii::internal::FEValuesImplementation::FiniteElementRelatedData &output_data) const override { + (void)mapping; + // generate a new data object and // initialize some fields std::unique_ptr::InternalDataBase> diff --git a/include/deal.II/fe/fe_poly_face.h b/include/deal.II/fe/fe_poly_face.h index cd2be76ff1..f8d9695a3a 100644 --- a/include/deal.II/fe/fe_poly_face.h +++ b/include/deal.II/fe/fe_poly_face.h @@ -88,25 +88,31 @@ protected: virtual std::unique_ptr< typename FiniteElement::InternalDataBase> get_data( - const UpdateFlags /*update_flags*/, - const Mapping & /*mapping*/, - const Quadrature & /*quadrature*/, + const UpdateFlags update_flags, + const Mapping &mapping, + const Quadrature & quadrature, dealii::internal::FEValuesImplementation::FiniteElementRelatedData - & /*output_data*/) const override + &output_data) const override { + (void)update_flags; + (void)mapping; + (void)quadrature; + (void)output_data; return std::make_unique(); } std::unique_ptr::InternalDataBase> get_face_data( - const UpdateFlags update_flags, - const Mapping & /*mapping*/, - const Quadrature &quadrature, + const UpdateFlags update_flags, + const Mapping &mapping, + const Quadrature & quadrature, dealii::internal::FEValuesImplementation::FiniteElementRelatedData - & /*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::InternalDataBase> diff --git a/include/deal.II/fe/fe_poly_tensor.h b/include/deal.II/fe/fe_poly_tensor.h index 914e1ec089..d12c4c9145 100644 --- a/include/deal.II/fe/fe_poly_tensor.h +++ b/include/deal.II/fe/fe_poly_tensor.h @@ -236,13 +236,15 @@ protected: virtual std::unique_ptr< typename FiniteElement::InternalDataBase> get_data( - const UpdateFlags update_flags, - const Mapping & /*mapping*/, - const Quadrature &quadrature, + const UpdateFlags update_flags, + const Mapping &mapping, + const Quadrature & quadrature, dealii::internal::FEValuesImplementation::FiniteElementRelatedData - & /*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::InternalDataBase> diff --git a/include/deal.II/fe/mapping_fe.h b/include/deal.II/fe/mapping_fe.h index aa96493fcb..fb26cd76da 100644 --- a/include/deal.II/fe/mapping_fe.h +++ b/include/deal.II/fe/mapping_fe.h @@ -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 diff --git a/include/deal.II/matrix_free/evaluation_kernels.h b/include/deal.II/matrix_free/evaluation_kernels.h index 5748e4f375..5b80b6d82f 100644 --- a/include/deal.II/matrix_free/evaluation_kernels.h +++ b/include/deal.II/matrix_free/evaluation_kernels.h @@ -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. diff --git a/include/deal.II/particles/particle.h b/include/deal.II/particles/particle.h index 0cf7d050ef..81b3197827 100644 --- a/include/deal.II/particles/particle.h +++ b/include/deal.II/particles/particle.h @@ -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 diff --git a/include/deal.II/particles/particle_accessor.h b/include/deal.II/particles/particle_accessor.h index 2265d10af0..c3083bfbde 100644 --- a/include/deal.II/particles/particle_accessor.h +++ b/include/deal.II/particles/particle_accessor.h @@ -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 diff --git a/include/deal.II/simplex/polynomials.h b/include/deal.II/simplex/polynomials.h index 02f62ba434..7561d28a3a 100644 --- a/include/deal.II/simplex/polynomials.h +++ b/include/deal.II/simplex/polynomials.h @@ -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 @p grads are filled. */ void evaluate(const Point & unit_point,