]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Fixed DW comments.
authorLuca Heltai <luca.heltai@sissa.it>
Sun, 15 Apr 2018 22:38:15 +0000 (00:38 +0200)
committerLuca Heltai <luca.heltai@sissa.it>
Sun, 15 Apr 2018 22:38:15 +0000 (00:38 +0200)
doc/news/changes/minor/20180406LucaHeltai
include/deal.II/base/patterns.h

index 120b5aff4dd77690c467185f625875682404d77e..9504ebf33c009b0962033b40f8466f48288a6ab6 100644 (file)
@@ -1,5 +1,5 @@
 New: Patterns::Tools::to_string() and Patterns::Tools::to_value() simplify the conversion to and from
-strings of arbirarily complex types. 
+strings of arbitrarily complex types. 
 <br>
 (Luca Heltai, 2018/04/06)
 
index 9fe3d0c21998a5dd3e453e901205f38c75672593..700c621e8f826786442643032032f984b00020df 100644 (file)
@@ -1276,9 +1276,13 @@ namespace Patterns
      * auto t = std::make_tuple(1.0, std::make_pair(1, "ciao"));
      * auto s = Patterns::Tools::to_string(t);
      *
-     * std::cout << s; // will print "1 % 1 : ciao
+     * std::cout << s; // will print "1 % 1 : ciao""
      * @endcode
      *
+     * See the documentation of the class Patterns::Tools::Convert, and of the
+     * helper class Patterns::Tools::RankInfo for details on the way separators
+     * are selected when outputting STL container types.
+     *
      * @author Luca Heltai, 2018
      */
     template<typename T>
@@ -1295,9 +1299,14 @@ namespace Patterns
      * auto t = std::make_tuple(1.0, std::make_pair(1, "ciao"));
      * to_value("2 % 3 : mondo", t);
      * auto s = Patterns::Tools::to_string(t);
-     * std::cout << s; // will print "2 % 3 : mondo
+     * std::cout << s; // will print "2 % 3 : mondo""
      * @endcode
      *
+     * See the documentation of the class Patterns::Tools::Convert, and of the
+     * helper class Patterns::Tools::RankInfo for details on the separators you
+     * should use in your string patterns when converting from a string to a
+     * container type.
+     *
      * @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.