From: Luca Heltai Date: Thu, 26 Oct 2017 12:48:26 +0000 (+0200) Subject: Fixed comments by Denis X-Git-Tag: v9.0.0-rc1~864^2~3 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=970bc95b96132860a56fb2f221c4ea69e5cb4290;p=dealii.git Fixed comments by Denis --- diff --git a/include/deal.II/base/patterns.h b/include/deal.II/base/patterns.h index 60e1fd1da9..17fb778c2b 100644 --- a/include/deal.II/base/patterns.h +++ b/include/deal.II/base/patterns.h @@ -666,9 +666,24 @@ namespace Patterns * This pattern matches comma-separated values of arbitrary types. Each type * has to match a pattern given to the constructor. * - * The constructor expects a vector of Patterns, and optionally an - * std::string, specifying the separator to use when parsing the Tuple from a - * string. + * An example usage is the following: + * + * @code + * std::vector< std::unique_ptr > ps; + * + * ps.push_back(std::unique_ptr()); + * ps.push_back(std::unique_ptr()); + * ps.push_back(std::unique_ptr()); + * + * Patterns::Tuple pattern(ps, ";"); + * + * bool check = ps.match("5; 3.14; Ciao"); // check = true + * @endcode + * + * The constructor expects a vector of Patterns, and optionally a string + * specifying the separator to use when parsing the Tuple from a string. + * + * @author Luca Heltai, 2017. */ class Tuple : public PatternBase {