From: David Wells Date: Fri, 20 Sep 2024 18:55:23 +0000 (-0400) Subject: FunctionParser: document where we use commas. X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F17720%2Fhead;p=dealii.git FunctionParser: document where we use commas. We use semicolons in some places in the library and it took me a few minutes to figure out why those didn't work here. --- diff --git a/include/deal.II/base/function_parser.h b/include/deal.II/base/function_parser.h index 5f93738b69..2315cfb504 100644 --- a/include/deal.II/base/function_parser.h +++ b/include/deal.II/base/function_parser.h @@ -284,14 +284,14 @@ public: /** * Initialize the object by setting the actual parsed functions. * - * @param[in] vars a string with the variables that will be used by the - * expressions to be evaluated. Note that the variables can have any name - * (of course different from the function names defined above!), but the - * order IS important. The first variable will correspond to the first + * @param[in] vars a string with the variables, separated by commas, that will + * be used by the expressions to be evaluated. Note that the variables can + * have any name (of course different from the function names defined above!), + * but the order IS important. The first variable will correspond to the first * component of the point in which the function is evaluated, the second * variable to the second component and so forth. If this function is also * time dependent, then it is necessary to specify it by setting the - * time_dependent parameter to true. An exception is thrown if + * time_dependent parameter to true. An exception is thrown if * the number of variables specified here is different from dim (if this * function is not time-dependent) or from dim+1 (if it is time-dependent). *