From: Daniel Arndt Date: Wed, 8 Apr 2020 19:25:27 +0000 (-0400) Subject: Improve CellWeights documentation X-Git-Tag: v9.2.0-rc1~259^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F9861%2Fhead;p=dealii.git Improve CellWeights documentation --- diff --git a/include/deal.II/distributed/cell_weights.h b/include/deal.II/distributed/cell_weights.h index 924d6fc7f1..50dd53b954 100644 --- a/include/deal.II/distributed/cell_weights.h +++ b/include/deal.II/distributed/cell_weights.h @@ -197,19 +197,27 @@ namespace parallel CellWeights(const hp::DoFHandler &dof_handler); /** - * @copydoc CellWeights::constant_weighting() + * Choose a constant weight @p factor on each cell. + * + * @deprecated Use CellWeights::constant_weighting() instead. */ DEAL_II_DEPRECATED void register_constant_weighting(const unsigned int factor = 1000); /** - * @copydoc CellWeights::ndofs_weighting() + * Choose a weight for each cell that is proportional to its number of + * degrees of freedom with a factor @p factor. + * + * @deprecated Use CellWeights::ndofs_weighting() instead. */ DEAL_II_DEPRECATED void register_ndofs_weighting(const unsigned int factor = 1000); /** - * @copydoc CellWeights::ndofs_squared_weighting() + * Choose a weight for each cell that is proportional to its number of + * degrees of freedom squared with a factor @p factor. + * + * @deprecated Use CellWeights::ndofs_weighting() instead. */ DEAL_II_DEPRECATED void register_ndofs_squared_weighting(const unsigned int factor = 1000);