From: Wolfgang Bangerth Date: Thu, 11 Jul 2024 13:21:51 +0000 (-0600) Subject: Updates to the LogStream documentation. X-Git-Tag: v9.6.0-rc1~95^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7c2b6e0c38eeb3d262f56a1153c8f0e29306c991;p=dealii.git Updates to the LogStream documentation. --- diff --git a/include/deal.II/base/logstream.h b/include/deal.II/base/logstream.h index c20df0fc49..762a5141d2 100644 --- a/include/deal.II/base/logstream.h +++ b/include/deal.II/base/logstream.h @@ -218,11 +218,11 @@ public: /** - * Maximum number of levels to be printed on the console. The default is 0, - * which will not generate any output. This function allows one to restrict - * console output to the highest levels of iterations. Only output with less - * than n prefixes is printed. By calling this function with - * n=0, no console output will be written. See step-3 for an + * Set the maximum number of levels to be printed on the console. The default + * is 0, which will not generate any output. This function allows one to + * restrict console output to the highest levels of iterations. Only output + * with less than n prefixes is printed. By calling this function + * with n=0, no console output will be written. See step-3 for an * example usage of this method. * * The previous value of this parameter is returned. @@ -232,9 +232,10 @@ public: /** - * Maximum number of levels to be written to the log file. The functionality - * is the same as depth_console, nevertheless, this function should - * be used with care, since it may spoil the value of a log file. + * Set the maximum number of levels to be written to the log file. The + * functionality is the same as depth_console, nevertheless, this + * function should be used with care, since it may spoil the value of a log + * file. * * The previous value of this parameter is returned. */ @@ -250,7 +251,7 @@ public: /** - * set the precision for the underlying stream and returns the previous + * Set the precision for the underlying stream and returns the previous * stream precision. This function mimics * http://www.cplusplus.com/reference/ios/ios_base/precision/ */ @@ -259,7 +260,7 @@ public: /** - * set the width for the underlying stream and returns the previous stream + * Set the width for the underlying stream and returns the previous stream * width. This function mimics * http://www.cplusplus.com/reference/ios/ios_base/width/ */