src/include/time_measure.h
changeset 458 2df1fee6c866
parent 440 f92099d27236
child 491 4804c967543d
     1.1 --- a/src/include/time_measure.h	Wed Apr 28 12:33:05 2004 +0000
     1.2 +++ b/src/include/time_measure.h	Wed Apr 28 12:58:58 2004 +0000
     1.3 @@ -28,6 +28,10 @@
     1.4    ///
     1.5    /// TimeStamp's can be added to or substracted from each other and
     1.6    /// they can be pushed to a stream.
     1.7 +  ///
     1.8 +  /// In most cases, perhaps \ref Timer class is what you want to use instead.
     1.9 +  ///
    1.10 +  ///\author Alpar Juttner
    1.11  
    1.12    class TimeStamp
    1.13    {
    1.14 @@ -119,6 +123,30 @@
    1.15    };
    1.16  
    1.17    ///Class measuring the cpu time and real time usage of the process
    1.18 +
    1.19 +  ///Class measuring the cpu time and real time usage of the process.
    1.20 +  ///It is quite easy-to-use, here is a short example.
    1.21 +  ///\code
    1.22 +  ///int main()
    1.23 +  ///{
    1.24 +  ///
    1.25 +  ///  ...
    1.26 +  ///
    1.27 +  ///  Timer T();
    1.28 +  ///  doSomething();
    1.29 +  ///  cout << T;
    1.30 +  ///  T.reset();
    1.31 +  ///  doSomethingElse();
    1.32 +  ///  cout << T;
    1.33 +  ///
    1.34 +  ///  ...
    1.35 +  ///
    1.36 +  ///}
    1.37 +  ///\endcode
    1.38 +  ///
    1.39 +  ///\todo This shouldn't be Unix (Linux) specific.
    1.40 +  ///
    1.41 +  ///\author Alpar Juttner
    1.42    class Timer
    1.43    {
    1.44      TimeStamp start_time;