Changeset 458:2df1fee6c866 in lemon-0.x for src/include/time_measure.h

Timestamp:

04/28/04 14:58:58 (20 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@606

Message:

Docs.

File:

• src/include/time_measure.h (modified) (2 diffs)

src/include/time_measure.h

@@ -29 +29 @@
   /// TimeStamp's can be added to or substracted from each other and
   /// they can be pushed to a stream.
+  ///
+  /// In most cases, perhaps \ref Timer class is what you want to use instead.
+  ///
+  ///\author Alpar Juttner
 
   class TimeStamp
@@ -120 +124 @@
 
   ///Class measuring the cpu time and real time usage of the process
+
+  ///Class measuring the cpu time and real time usage of the process.
+  ///It is quite easy-to-use, here is a short example.
+  ///\code
+  ///int main()
+  ///{
+  ///
+  ///  ...
+  ///
+  ///  Timer T();
+  ///  doSomething();
+  ///  cout << T;
+  ///  T.reset();
+  ///  doSomethingElse();
+  ///  cout << T;
+  ///
+  ///  ...
+  ///
+  ///}
+  ///\endcode
+  ///
+  ///\todo This shouldn't be Unix (Linux) specific.
+  ///
+  ///\author Alpar Juttner
   class Timer
   {