]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
changes for Doxyhen
authorguido <guido@0785d39b-7218-0410-832d-ea1e28bc413d>
Sun, 11 Jan 2004 12:30:05 +0000 (12:30 +0000)
committerguido <guido@0785d39b-7218-0410-832d-ea1e28bc413d>
Sun, 11 Jan 2004 12:30:05 +0000 (12:30 +0000)
git-svn-id: https://svn.dealii.org/trunk@8303 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/base/include/base/quadrature.h
deal.II/base/include/base/timer.h

index bfaea23998454999dc7a0ecbebf76fcbf9facfd1..3fa7d8b7f9eeefeed4d411929964cf03dc0bbd0b 100644 (file)
@@ -70,6 +70,8 @@
  * necessary to provide a class Point@<0@> to make the compiler
  * happy. This class also does nothing.
  *
+ * @ref Instantiations: few
+ *
  * @author Wolfgang Bangerth, 1998, 1999, 2000
  */
 template <int dim>
index d373e92e2ec4a1a8837056ec3360a2b984ad32c6..39c209bd7ccdac13ddef9200567e1d587500f992 100644 (file)
@@ -2,7 +2,7 @@
 //    $Id$
 //    Version: $Name$
 //
-//    Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003 by the deal authors
+//    Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004 by the deal authors
 //
 //    This file is subject to QPL and may not be  distributed
 //    without copyright and license information. Please refer
  * microsecond. 
  *
  *
- * @sect3{Usage}
+ * @section TimerUsage Usage
  *
  * Use of this class is as you might expect by looking at the member
  * functions:
- * @begin{verbatim}
+ * @code
  *   Time timer;
  *   timer.start ();
  *
  *
  *   // reset timer for the next thing it shall do
  *   timer.reset();
- * @end{verbatim}
+ * @endcode
  *
  * Alternatively, you can also restart the timer instead of resetting
- * it. The times between successive calls to <tt>start/stop</tt> will then be
+ * it. The times between successive calls to start()/ stop() will then be
  * accumulated.
  *
- * Note: the implementation of this class is system dependent.
+ * @note Implementation of this class is system
+ * dependent. Unfortunately, it does not work with multithreading
+ * right now. In this case, we would like to sum up the time needed by
+ * all children. Furthermore, a wall clock option would be nice.
  *
  * @author G. Kanschat, W. Bangerth
  */
@@ -92,22 +95,22 @@ class Timer
   private:
 
                                     /**
-                                     * Value of the user time when <tt>start</tt>
+                                     * Value of the user time when start()
                                      * was called the last time or when the
-                                     * object was created and no <tt>stop</tt> was
+                                     * object was created and no stop() was
                                      * issued in between.
                                      */
     double              start_time;
 
 
                                     /**
-                                     * Similar to <tt>start_time</tt>, but
+                                     * Similar to #start_time, but
                                      * needed for children threads
                                      * in multithread mode. Value of
-                                     * the user time when <tt>start</tt>
+                                     * the user time when start()
                                      * was called the last time or
                                      * when the object was created
-                                     * and no <tt>stop</tt> was issued in
+                                     * and no stop() was issued in
                                      * between.
                                      *
                                      * For some reason (error in
@@ -116,7 +119,7 @@ class Timer
                                      * <tt>getrusage(RUSAGE_CHILDREN,.)</tt>
                                      * gives always 0 (at least
                                      * on Solaris7). Hence the
-                                     * <tt>Timer</tt> class still does not
+                                     * Timer class still does not
                                      * yet work for multithreading
                                      * mode.
                                      */
@@ -124,7 +127,7 @@ class Timer
 
                                     /**
                                      * Accumulated time for all previous
-                                     * <tt>start</tt>/<tt>stop</tt> cycles. The time for
+                                     * start()/stop() cycles. The time for
                                      * the present cycle is not included.
                                      */
     double              cumulative_time;

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.