]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Doc update.
authorwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Tue, 30 Nov 1999 15:14:18 +0000 (15:14 +0000)
committerwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Tue, 30 Nov 1999 15:14:18 +0000 (15:14 +0000)
git-svn-id: https://svn.dealii.org/trunk@1961 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/base/include/base/data_out_base.h
deal.II/base/include/base/timer.h
deal.II/lac/include/lac/block_vector.h

index 12e3e7ac0cd207f4e7695d2948be302dbee81212..6364a9de70bc7bd179a57b033a4fa18cbb700cd6 100644 (file)
 
  * \begin{itemize}
  *
- * \item BICUBIC_PATCH
+ * \item #BICUBIC_PATCH#
  * A bicubic_patch is a 3-dimensional Bezier patch. It consists of 16 Points
  * describing the surface. The 4 corner points are touched by the object,
  * while the other 12 points pull and stretch the patch into shape.
  * subdivisions has to be 3 to provide the patch with 16 points.
  * A bicubic patch is not exact but generates very smooth images.
  *
- * \item MESH
+ * \item #MESH#
  * The mesh object is used to store large number of triangles.
  * Every square of the patch data is split into one upper-left and one 
  * lower-right triangle. If the number of subdivisions is three, 32 triangle
  * 
  * Using the smooth flag povray interpolates the normals on the triangles,
  * imitating a curved surface
- *
  * \end{itemize}
  *
  * All objects get one texture definition called Tex. This texture has to be
index 340729fd75e1964d31756ae9d3bb178f926960c6..922743bb8b4c07d1f072acb2b41fd97f433664c0 100644 (file)
  * microsecond. 
  *
  *
-//TODO: * \subsection{Usage}
+ * \subsection{Usage}
  *
+ * Use of this class is as you might expect by looking at the member
+ * functions:
+ * \begin{verbatim}
+ *   Time timer;
+ *   timer.start ();
+ *
+ *   // do some complicated computations here
+ *   ...
+ *
+ *   timer.stop ();
+ *
+ *   cout << "Elapsed time: " << timer() << " seconds.";
+ *
+ *   // reset timer for the next thing it shall do
+ *   timer.reset();
+ * \end{verbatim}
+ *
+ * Alternatively, you can also restart the timer instead of resetting
+ * it. The times between successive calls to #start/stop# will then be
+ * accumulated.
  *
  * Note: the implementation of this class is system dependant.
  *
@@ -36,8 +56,9 @@ public:
     void start();
 
                                     /**
-                                     * Sets the current time as next starting
-                                     * time and return it.
+                                     * Sets the current time as next
+                                     * starting time and return the
+                                     * elapsed time in seconds.
                                      */
     double stop();
 
@@ -48,13 +69,19 @@ public:
     void reset();
 
                                     /**
-                                     * Access to the current time without
-                                     * disturbing time measurement.
+                                     * Access to the current time
+                                     * without disturbing time
+                                     * measurement. The elapsed time
+                                     * is returned in units of
+                                     * seconds.
+                                     *
+                                     * A regular call to this
+                                     * function serves to avoid time
+                                     * overflow (which is now nearly
+                                     * every 30 minutes on UNIX
+                                     * machines) in long-time
+                                     * measurements.
                                      */
-  // A regular call to this function serves to avoid time overflow
-  // (which is now nearly every 30 minutes on UNIX machines) in long-time
-  // measurements.
-  //
     double operator() () const;
 
   private:
index dfccab5ce4b7be644ac0a55c81583e8485d74604..ae184b777ebd44d608e253e4619efbe712b4340f 100644 (file)
@@ -213,7 +213,7 @@ class BlockVector
 //                                   * the element past the end of the array.
 //                                   */
 //      const_iterator end () const;  
-//                                  //@}
+
     
     
                                     /**

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.