]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Fixed minor comments. 6178/head
authorLuca Heltai <luca.heltai@sissa.it>
Wed, 25 Apr 2018 22:17:03 +0000 (00:17 +0200)
committerLuca Heltai <luca.heltai@sissa.it>
Wed, 25 Apr 2018 22:22:18 +0000 (00:22 +0200)
include/deal.II/base/patterns.h

index 700c621e8f826786442643032032f984b00020df..842d65e91e11211ca4b153ebf7cfee576d07ef3f 100644 (file)
@@ -1297,7 +1297,9 @@ namespace Patterns
      *
      * @code
      * auto t = std::make_tuple(1.0, std::make_pair(1, "ciao"));
-     * to_value("2 % 3 : mondo", t);
+     * // replace the value of 't' by the parsed content of the string argument:
+     * Patterns::Tools::to_value("2 % 3 : mondo", t);
+     *
      * auto s = Patterns::Tools::to_string(t);
      * std::cout << s; // will print "2 % 3 : mondo""
      * @endcode
@@ -1307,6 +1309,10 @@ namespace Patterns
      * should use in your string patterns when converting from a string to a
      * container type.
      *
+     * Notice that the current content of variable @p t is ignored. Its type is
+     * used to infer how to interpret the string. If the string is succesfully
+     * parsed, then @p t will be set to the parsed content of @p s.
+     *
      * @author Luca Heltai, 2018
      */
     template<typename T>

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.