From: Wolfgang Bangerth Date: Fri, 24 Apr 2009 00:09:44 +0000 (+0000) Subject: Avoid the use of @brief which appears to confuse doxygen (it won't X-Git-Tag: v8.0.0~7760 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1846eb34ae8161ebc1c4332d16effd24f8da55b3;p=dealii.git Avoid the use of @brief which appears to confuse doxygen (it won't find a link within the same html page). git-svn-id: https://svn.dealii.org/trunk@18730 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/deal.II/include/grid/grid_refinement.h b/deal.II/deal.II/include/grid/grid_refinement.h index 14492cd2f4..f9540a490d 100644 --- a/deal.II/deal.II/include/grid/grid_refinement.h +++ b/deal.II/deal.II/include/grid/grid_refinement.h @@ -46,9 +46,9 @@ template class Vector; namespace GridRefinement { /** - * @brief Refinement strategy with predictable growth of the mesh + * This function provides a refinement strategy with predictable growth of the mesh. * - * This function takes a vector of refinement @p criteria and two values + * The function takes a vector of refinement @p criteria and two values * between zero and one denoting the fractions of cells to be refined * and coarsened. It flags cells for further processing by * Triangulation::execute_coarsening_and_refinement() according to the @@ -119,7 +119,8 @@ namespace GridRefinement const unsigned int max_n_cells = std::numeric_limits::max()); /** - * @brief Refinement strategy controlling the reduction of the error estimate + * This function provides a refinement strategy controlling the + * reduction of the error estimate. * * Also known as the bulk criterion, this function computes the * thresholds for refinement and coarsening such that the @p criteria