[Lemon-commits] alpar: r3421 - in lemon/trunk: contrib lemon

[Lemon SVN]

Author: alpar
Date: Wed Dec 19 10:16:22 2007
New Revision: 3421

Added:
   lemon/trunk/contrib/
Modified:
   lemon/trunk/lemon/time_measure.h

Log:
Change the local variables lower case


Modified: lemon/trunk/lemon/time_measure.h
==============================================================================
--- lemon/trunk/lemon/time_measure.h	(original)
+++ lemon/trunk/lemon/time_measure.h	Wed Dec 19 10:16:22 2007
@@ -241,12 +241,12 @@
   ///
   ///   ...
   ///
-  ///   Timer T;
+  ///   Timer t;
   ///   doSomething();
-  ///   std::cout << T << '\n';
-  ///   T.restart();
+  ///   std::cout << t << '\n';
+  ///   t.restart();
   ///   doSomethingElse();
-  ///   std::cout << T << '\n';
+  ///   std::cout << t << '\n';
   ///
   ///   ...
   ///
@@ -261,7 +261,7 @@
   ///the time counters have a certain (10ms on a typical Linux system)
   ///granularity.
   ///Therefore this tool is not appropriate to measure very short times.
-  ///Also, if you start and stop the timer very frequently, it could lead
+  ///Also, if you start and stop the timer very frequently, it could lead to
   ///distorted results.
   ///
   ///\note If you want to measure the running time of the execution of a certain
@@ -348,7 +348,13 @@
 
     ///Halt (i.e stop immediately) the time counters
 
-    ///This function stops immediately the time counters.
+    ///This function stops immediately the time counters, i.e. <tt>t.stop()</tt>
+    ///is a faster
+    ///equivalent of the following.
+    ///\code
+    ///  while(t.running()) t.stop()
+    ///\endcode
+    ///
     ///
     ///\sa stop()
     ///\sa restart()
@@ -422,9 +428,9 @@
     ///This conversion computes the ellapsed time, therefore you can print
     ///the ellapsed time like this.
     ///\code
-    ///  Timer T;
+    ///  Timer t;
     ///  doSomething();
-    ///  std::cout << T << '\n';
+    ///  std::cout << t << '\n';
     ///\endcode
     operator TimeStamp () const
     {
@@ -444,7 +450,7 @@
   ///\code
   ///  void myAlg(ListGraph &g,int n)
   ///  {
-  ///    TimeReport TR("Running time of myAlg: ");
+  ///    TimeReport tr("Running time of myAlg: ");
   ///    ... //Here comes the algorithm
   ///  }
   ///\endcode