From: guido Date: Mon, 25 Jan 1999 18:11:44 +0000 (+0000) Subject: More documentation X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=144944178d806e1dc02d7d08561eb3193b5a4f25;p=dealii-svn.git More documentation git-svn-id: https://svn.dealii.org/trunk@743 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/base/include/base/logstream.h b/deal.II/base/include/base/logstream.h index 0bf65b5b6c..9a70de5bf2 100644 --- a/deal.II/base/include/base/logstream.h +++ b/deal.II/base/include/base/logstream.h @@ -20,6 +20,20 @@ * \item the possibility of distributing information to files and the * console. * \end{itemize} + * + * The usual usage of this class is through the pregenerated object + * #deallog#. Typical steps are + *
    + *
  1. #deallog.attach(ostream)#: write logging information into a file. + *
  2. #deallog.depth_console(n)#: restrict output on screen to outer loops. + *
  3. Before entering a new phase of your program, e.g. a new loop, + * #deallog.push("loopname")#. + *
  4. #deallog << anything << endl;# to write logging information + * (Usage of #endl# is mandatory!). + *
  5. #deallog.pop()# when leaving that stage entered with #push#. + *
+ * + * @author Guido Kanschat, 1999 */ class LogStream { @@ -216,10 +230,14 @@ operator << (LogStream& s, const T& t) /** + * Replacement of #endl# for #LogStream#. + * * Overloaded version of the stream manipulator function #endl# which * results in calling the original version of #endl# for each of the * two streams, if the present prefix number does not exceed the * specified maximal number. + * + * @author Guido Kanschat, 1999 */ inline void endl(LogStream& s) { @@ -234,8 +252,11 @@ inline void endl(LogStream& s) s.was_endl = true; } - - +/** + * The standard log object of DEAL. + * + * @author Guido Kanschat, 1999 + */ extern LogStream deallog;