From 584cb653dc351b868987eea916b75f5d69a282e6 Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Tue, 10 Oct 2017 17:01:51 -0600 Subject: [PATCH] Update documentation of LogStream::push(). --- include/deal.II/base/logstream.h | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) 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); -- 2.39.5