* \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
* 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.
*
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();
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: