]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Update documentation of LogStream::push(). 5224/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Tue, 10 Oct 2017 23:01:51 +0000 (17:01 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Tue, 10 Oct 2017 23:01:51 +0000 (17:01 -0600)
include/deal.II/base/logstream.h

index a5eb65d40fe74c1aa34ab2a87ef98dd51211f729..8b3710fec4b646db0429a102454966e9e8e223fc 100644 (file)
@@ -186,7 +186,12 @@ public:
    * a colon and there is a double colon after the last prefix.
    *
    * A simpler way to add a prefix (without the manual need to add the
-   * corresponding pop()) is to use the Prefix class.
+   * corresponding pop()) is to use the LogStream::Prefix class. Using
+   * that class has the advantage that the corresponding pop() call is
+   * issued whenever the Prefix object goes out of scope -- either at
+   * the end of the code block, at the nearest @p return statement, or
+   * because an intermediate function call results in an exception that
+   * is not immediately caught.
    */
   void push (const std::string &text);
 

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.