From: Wolfgang Bangerth <bangerth@colostate.edu>
Date: Tue, 10 Oct 2017 23:01:51 +0000 (-0600)
Subject: Update documentation of LogStream::push().
X-Git-Tag: v9.0.0-rc1~967^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=584cb653dc351b868987eea916b75f5d69a282e6;p=dealii.git

Update documentation of LogStream::push().
---

diff --git a/include/deal.II/base/logstream.h b/include/deal.II/base/logstream.h
index a5eb65d40f..8b3710fec4 100644
--- a/include/deal.II/base/logstream.h
+++ b/include/deal.II/base/logstream.h
@@ -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);