From: Luca Heltai Date: Thu, 2 May 2019 07:58:30 +0000 (+0200) Subject: Fix documentation. X-Git-Tag: v9.1.0-rc1~143^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F7905%2Fhead;p=dealii.git Fix documentation. --- diff --git a/include/deal.II/base/parsed_convergence_table.h b/include/deal.II/base/parsed_convergence_table.h index 32b14fe04a..8fd6d75c80 100644 --- a/include/deal.II/base/parsed_convergence_table.h +++ b/include/deal.II/base/parsed_convergence_table.h @@ -228,10 +228,10 @@ public: * # The exponent to use when computing p-norms. * set Exponent for p-norms = 2 * - * # Each component is separated by a semicolon, and each norm by a comma. - * # Implemented norms are Linfty, L2, W1infty, H1, and custom. If you want to - * # skip a component, use none. - * set List of error norms to compute = Linfty, L2, H1 + * # Each component is separated by a semicolon and each norm by a comma. See + * # the documentation of VectorTools::NormType for a list of implemented + * # norms. If you want to skip a component, leave its entry empty. + * set List of error norms to compute = Linfty_norm, L2_norm, H1_norm * * # Key to use when computing convergence rates. If this is set to a * # column that is not present, or to none, then no error rates are computed. diff --git a/source/base/parsed_convergence_table.cc b/source/base/parsed_convergence_table.cc index 72761b3065..cb00e76f1c 100644 --- a/source/base/parsed_convergence_table.cc +++ b/source/base/parsed_convergence_table.cc @@ -125,8 +125,9 @@ ParsedConvergenceTable::add_parameters(ParameterHandler &prm) "List of error norms to compute", norms_per_unique_component, "Each component is separated by a semicolon " - "and each norm by a comma. Implemented norms are Linfty, L2, " - "W1infty, H1, and custom. If you want to skip a component, use none."); + "and each norm by a comma. See the documentation of VectorTools::NormType " + "for a list of implemented norms. If you want to skip a component, leave " + "its entry empty."); prm.add_parameter("Exponent for p-norms",