From: Wolfgang Bangerth Date: Sat, 22 Apr 2023 00:28:12 +0000 (-0600) Subject: A variety of doxygen fixes. X-Git-Tag: v9.5.0-rc1~292^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F15129%2Fhead;p=dealii.git A variety of doxygen fixes. --- diff --git a/include/deal.II/distributed/grid_refinement.h b/include/deal.II/distributed/grid_refinement.h index 9ef0a5c6d5..1aef1a106b 100644 --- a/include/deal.II/distributed/grid_refinement.h +++ b/include/deal.II/distributed/grid_refinement.h @@ -68,7 +68,9 @@ namespace internal /** * Compute a threshold value so that the error accumulated over all * criteria[i] so that + * @code * criteria[i] > threshold + * @endcode * is larger than target_error. */ template diff --git a/include/deal.II/fe/fe_p1nc.h b/include/deal.II/fe/fe_p1nc.h index 0260833283..a8830e3a24 100644 --- a/include/deal.II/fe/fe_p1nc.h +++ b/include/deal.II/fe/fe_p1nc.h @@ -301,8 +301,8 @@ private: * Do the work which is needed before cellwise data computation. * Since the shape functions are constructed independently on each cell, * the data on the reference cell is not necessary. - * It returns an empty variable type of @ InternalDataBase and updates @ - * update_flags, and computes trivially zero Hessian for each cell if it is + * It returns an empty variable of type @p InternalDataBase and stores + * @p update_flags, and computes trivially zero Hessian for each cell if it is * needed. */ virtual std::unique_ptr::InternalDataBase> diff --git a/include/deal.II/grid/grid_refinement.h b/include/deal.II/grid/grid_refinement.h index b9996eb83f..39c348fc36 100644 --- a/include/deal.II/grid/grid_refinement.h +++ b/include/deal.II/grid/grid_refinement.h @@ -66,11 +66,11 @@ namespace GridRefinement * @param[in] max_n_cells The maximal number of cells. If current cell * number @p current_n_cells is already exceeded maximal cell number @p * max_n_cells, refinement fraction of cells will be set to zero and - * coarsening fraction of cells will be adjusted to reduce cell number to @ - * max_n_cells. If cell number is going to be exceeded only upon refinement, - * then refinement and coarsening fractions are going to be adjusted with a - * same ratio in an attempt to reach the maximum number of cells. Be aware - * though that through proliferation of refinement due to + * coarsening fraction of cells will be adjusted to reduce cell number to + * @p max_n_cells. If cell number is going to be exceeded only upon + * refinement, then refinement and coarsening fractions are going to be + * adjusted with a same ratio in an attempt to reach the maximum number of + * cells. Be aware though that through proliferation of refinement due to * Triangulation::MeshSmoothing, this number is only an indicator. The * default value of this argument is to impose no limit on the number of * cells. diff --git a/include/deal.II/lac/petsc_communication_pattern.h b/include/deal.II/lac/petsc_communication_pattern.h index 4670f9ea55..619801e2c6 100644 --- a/include/deal.II/lac/petsc_communication_pattern.h +++ b/include/deal.II/lac/petsc_communication_pattern.h @@ -232,8 +232,8 @@ namespace PETScWrappers /** * Reinitialize the partitioner. As for the Utilities::MPI::Partitioner, - * any entry of @p ghost_indices that is also present in @ - * locally_owned_indices is discarded. + * any entry of @p ghost_indices that is also present in + * @p locally_owned_indices is discarded. */ virtual void reinit(const IndexSet &locally_owned_indices, @@ -242,9 +242,9 @@ namespace PETScWrappers /** * Reinitialize the partitioner. As for the Utilities::MPI::Partitioner, - * any entry of @p ghost_indices that is also present in @ - * locally_owned_indices is discarded. This reinitialization will allow to - * perform communications either using a ghost data array of the size + * any entry of @p ghost_indices that is also present in + * @p locally_owned_indices is discarded. This reinitialization will allow + * to perform communications either using a ghost data array of the size * of @p ghost_indices or of @p larger_ghost_indices. */ void