From: Niklas Fehn Date: Wed, 6 May 2020 17:18:46 +0000 (+0200) Subject: clarify documentation of print_parameters() X-Git-Tag: v9.2.0-rc1~116^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7b1eedbae9ba26766b37ec3e288e7be1d5a1a956;p=dealii.git clarify documentation of print_parameters() --- diff --git a/include/deal.II/base/parameter_handler.h b/include/deal.II/base/parameter_handler.h index 80bdcebdca..4fdc503ece 100644 --- a/include/deal.II/base/parameter_handler.h +++ b/include/deal.II/base/parameter_handler.h @@ -1477,21 +1477,21 @@ public: /** - * Print all parameters with the given @p style to the file given by - * @p filename. + * Print all parameters to the file given by @p filename with the given output + * style @p style. * * This function deduces the output format from the extension of the specified - * filename. Supported extensions are `prm`, `xml`, `tex`, and `json`. - * If a different extensions is used, then an output style is deduced from the - * @p style argument. + * filename. Supported extensions are `prm`, `xml`, `tex`, and `json`. Hence, + * it is not necessary to specify an output format via the @p style argument + * as long as one of these extensions is added to the filename. If an output + * format is specified in the @p style parameter nevertheless, the output + * format has to be consistent with the filename extension. * - * Notice that specifying a supported file extension is equivalent to - * specifying the corresponding ParameterHandler::OutputStyle format. In - * particular, any (optional) format specification specified in the @p style - * parameter must be compatible with the given extension. + * If no extension is specified or the extension is not supported, the + * output format is deduced from the @p style argument. * - * If the format is not supported, and @p output_style does not contain a - * format specification, an assertion is thrown. + * If neither the extension is supported, nor does the @p style parameter + * contain a format specification, an assertion is thrown. * * @param filename The output file name. * @param style The style with which output is produced.