From: Menno Fraters Date: Fri, 14 Jun 2024 17:22:56 +0000 (-0400) Subject: Improve ParameterHanderl get current path functions. X-Git-Tag: v9.6.0-rc1~190^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F17124%2Fhead;p=dealii.git Improve ParameterHanderl get current path functions. --- diff --git a/include/deal.II/base/parameter_handler.h b/include/deal.II/base/parameter_handler.h index c8ff5a2dfe..bd2cbf5367 100644 --- a/include/deal.II/base/parameter_handler.h +++ b/include/deal.II/base/parameter_handler.h @@ -1274,25 +1274,28 @@ public: /** * Return the string that identifies the current path into the property - * tree. This is only a path, i.e. it is not terminated by the - * path_separator character. + * tree. The path elements are seperated by the path_separator, which is a + * '.'. This is only a path, i.e., it is not terminated by the path_separator + * character. * * This function simply calls collate_path_string() with - * @p subsection_path as argument + * @p subsection_path as argument. */ std::string get_current_path() const; /** * Given the name of an entry as argument, the function computes a full path - * into the parameter tree using the current subsection. + * into the parameter tree using the current subsection. The path elements are + * seperated by the path_separator, which is a '.'. */ std::string get_current_full_path(const std::string &name) const; /** * This function computes a full path into the parameter tree given a path - * from the current subsection and the name of an entry. + * from the current subsection and the name of an entry. The path elements are + * seperated by the path_separator, which is a '.'. */ std::string get_current_full_path(const std::vector &sub_path,