Change the local variables lower case
authoralpar
Wed, 19 Dec 2007 09:16:22 +0000
changeset 2543a0443c411220
parent 2542 faaa54ec4520
child 2544 5143b01bf1d5
Change the local variables lower case
lemon/time_measure.h
     1.1 --- a/lemon/time_measure.h	Mon Dec 17 09:54:26 2007 +0000
     1.2 +++ b/lemon/time_measure.h	Wed Dec 19 09:16:22 2007 +0000
     1.3 @@ -241,12 +241,12 @@
     1.4    ///
     1.5    ///   ...
     1.6    ///
     1.7 -  ///   Timer T;
     1.8 +  ///   Timer t;
     1.9    ///   doSomething();
    1.10 -  ///   std::cout << T << '\n';
    1.11 -  ///   T.restart();
    1.12 +  ///   std::cout << t << '\n';
    1.13 +  ///   t.restart();
    1.14    ///   doSomethingElse();
    1.15 -  ///   std::cout << T << '\n';
    1.16 +  ///   std::cout << t << '\n';
    1.17    ///
    1.18    ///   ...
    1.19    ///
    1.20 @@ -261,7 +261,7 @@
    1.21    ///the time counters have a certain (10ms on a typical Linux system)
    1.22    ///granularity.
    1.23    ///Therefore this tool is not appropriate to measure very short times.
    1.24 -  ///Also, if you start and stop the timer very frequently, it could lead
    1.25 +  ///Also, if you start and stop the timer very frequently, it could lead to
    1.26    ///distorted results.
    1.27    ///
    1.28    ///\note If you want to measure the running time of the execution of a certain
    1.29 @@ -348,7 +348,13 @@
    1.30  
    1.31      ///Halt (i.e stop immediately) the time counters
    1.32  
    1.33 -    ///This function stops immediately the time counters.
    1.34 +    ///This function stops immediately the time counters, i.e. <tt>t.stop()</tt>
    1.35 +    ///is a faster
    1.36 +    ///equivalent of the following.
    1.37 +    ///\code
    1.38 +    ///  while(t.running()) t.stop()
    1.39 +    ///\endcode
    1.40 +    ///
    1.41      ///
    1.42      ///\sa stop()
    1.43      ///\sa restart()
    1.44 @@ -422,9 +428,9 @@
    1.45      ///This conversion computes the ellapsed time, therefore you can print
    1.46      ///the ellapsed time like this.
    1.47      ///\code
    1.48 -    ///  Timer T;
    1.49 +    ///  Timer t;
    1.50      ///  doSomething();
    1.51 -    ///  std::cout << T << '\n';
    1.52 +    ///  std::cout << t << '\n';
    1.53      ///\endcode
    1.54      operator TimeStamp () const
    1.55      {
    1.56 @@ -444,7 +450,7 @@
    1.57    ///\code
    1.58    ///  void myAlg(ListGraph &g,int n)
    1.59    ///  {
    1.60 -  ///    TimeReport TR("Running time of myAlg: ");
    1.61 +  ///    TimeReport tr("Running time of myAlg: ");
    1.62    ///    ... //Here comes the algorithm
    1.63    ///  }
    1.64    ///\endcode