From: bangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Date: Sun, 27 Apr 2014 16:15:34 +0000 (+0000)
Subject: Clarify and correct documentation.
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b6d083d9e278493c3f26b299de83421101150d96;p=dealii-svn.git

Clarify and correct documentation.

git-svn-id: https://svn.dealii.org/trunk@32849 0785d39b-7218-0410-832d-ea1e28bc413d
---

diff --git a/deal.II/include/deal.II/base/timer.h b/deal.II/include/deal.II/base/timer.h
index 8a79dc56a7..c64013c639 100644
--- a/deal.II/include/deal.II/base/timer.h
+++ b/deal.II/include/deal.II/base/timer.h
@@ -414,27 +414,42 @@ public:
    * time we exit a section, just in the
    * end, both, or never.
    */
-  enum OutputFrequency {every_call, summary, every_call_and_summary, never}
+  enum OutputFrequency
+  {
+    every_call,
+    summary,
+    every_call_and_summary,
+    never
+  }
   output_frequency;
 
   /**
    * Sets whether to show CPU times, wall
    * times, or both CPU and wall times.
    */
-  enum OutputType      {cpu_times, wall_times, cpu_and_wall_times}
+  enum OutputType
+  {
+    cpu_times,
+    wall_times,
+    cpu_and_wall_times
+  }
   output_type;
 
   /**
-   * Constructor that takes std::cout as
-   * output stream.
+   * Constructor. Output is written to the stream (of type std::ostream)
+   * given as first argument. The second and third arguments denote how
+   * often output is to be generated and what kind of timing the output
+   * should represent (CPU or wall time).
    */
   TimerOutput (std::ostream              &stream,
                const enum OutputFrequency output_frequency,
                const enum OutputType      output_type);
 
   /**
-   * Constructor that takes a
-   * ConditionalOStream to write output to.
+   * Constructor. Output is written to the stream (of type ConditionalOstream)
+   * given as first argument. The second and third arguments denote how
+   * often output is to be generated and what kind of timing the output
+   * should represent (CPU or wall time).
    */
   TimerOutput (ConditionalOStream        &stream,
                const enum OutputFrequency output_frequency,