From 6cd401e3d3a0c146890fb3847e17dd2e529dbf4b Mon Sep 17 00:00:00 2001 From: Rene Gassmoeller Date: Mon, 26 Aug 2024 16:47:05 +0200 Subject: [PATCH] Address comments --- include/deal.II/base/parameter_handler.h | 15 ++++++++------- source/base/parameter_handler.cc | 4 ++-- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/include/deal.II/base/parameter_handler.h b/include/deal.II/base/parameter_handler.h index 20bfd4632b..3d7cad58c0 100644 --- a/include/deal.II/base/parameter_handler.h +++ b/include/deal.II/base/parameter_handler.h @@ -1130,21 +1130,22 @@ public: /** * Mark a previously declared parameter as deprecated. This will cause an * exception of type ExcEncounteredDeprecatedEntries to be thrown if - * the parameter is used in the input file. + * the parameter is used in an input file that is parsed by the + * parse_input() function. * - * The exception message will list the name of the parameter. + * The exception message will list the name of the parameter(s) that + * were encountered in the input file. * - * @param entry The name of the parameter to mark as deprecated. - * @param deprecation_status An optional parameter that can be used to - * toggle the deprecation status of the parameter. If set to true, the + * @param entry The name of the parameter to be marked as deprecated. + * @param is_deprecated An optional parameter that can be used to + * set the deprecation status of the parameter. If set to true, the * parameter will be marked as deprecated. This is the default behavior. * If set to false, the parameter will be marked as not deprecated. * This is useful if a parameter is marked as deprecated by * one function, but another function wants to keep using it. */ void - mark_as_deprecated(const std::string &entry, - const bool deprecation_status = true); + mark_as_deprecated(const std::string &entry, const bool is_deprecated = true); /** * Attach an action to the parameter with name @p entry in the current diff --git a/source/base/parameter_handler.cc b/source/base/parameter_handler.cc index ee11dddd86..4c26802c36 100644 --- a/source/base/parameter_handler.cc +++ b/source/base/parameter_handler.cc @@ -1006,7 +1006,7 @@ ParameterHandler::declare_alias(const std::string &existing_entry_name, void ParameterHandler::mark_as_deprecated(const std::string &existing_entry_name, - const bool deprecation_status) + const bool is_deprecated) { // assert that the entry exists Assert(entries->get_optional( @@ -1027,7 +1027,7 @@ ParameterHandler::mark_as_deprecated(const std::string &existing_entry_name, entries->put(get_current_full_path(existing_entry_name) + path_separator + "deprecation_status", - deprecation_status ? "true" : "false"); + is_deprecated ? "true" : "false"); } -- 2.39.5