From: wolf Date: Tue, 30 Nov 1999 15:14:18 +0000 (+0000) Subject: Doc update. X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7824401b55d965641b1c1202d932eec28a3c6896;p=dealii-svn.git Doc update. git-svn-id: https://svn.dealii.org/trunk@1961 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/base/include/base/data_out_base.h b/deal.II/base/include/base/data_out_base.h index 12e3e7ac0c..6364a9de70 100644 --- a/deal.II/base/include/base/data_out_base.h +++ b/deal.II/base/include/base/data_out_base.h @@ -152,7 +152,7 @@ * \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. @@ -160,7 +160,7 @@ * 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 @@ -168,7 +168,6 @@ * * 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 diff --git a/deal.II/base/include/base/timer.h b/deal.II/base/include/base/timer.h index 340729fd75..922743bb8b 100644 --- a/deal.II/base/include/base/timer.h +++ b/deal.II/base/include/base/timer.h @@ -14,8 +14,28 @@ * 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: diff --git a/deal.II/lac/include/lac/block_vector.h b/deal.II/lac/include/lac/block_vector.h index dfccab5ce4..ae184b777e 100644 --- a/deal.II/lac/include/lac/block_vector.h +++ b/deal.II/lac/include/lac/block_vector.h @@ -213,7 +213,7 @@ class BlockVector // * the element past the end of the array. // */ // const_iterator end () const; -// //@} + /**