1.1 --- a/lemon/time_measure.h Thu Oct 09 16:47:01 2008 +0200
1.2 +++ b/lemon/time_measure.h Thu Oct 09 16:20:37 2008 +0100
1.3 @@ -311,12 +311,11 @@
1.4 ///\name Control the state of the timer
1.5 ///Basically a Timer can be either running or stopped,
1.6 ///but it provides a bit finer control on the execution.
1.7 - ///The \ref Timer also counts the number of \ref start()
1.8 - ///executions, and is stops only after the same amount (or more)
1.9 - ///\ref stop() "stop()"s. This can be useful e.g. to compute
1.10 - ///the running time
1.11 + ///The \ref lemon::Timer "Timer" also counts the number of
1.12 + ///\ref lemon::Timer::start() "start()" executions, and it stops
1.13 + ///only after the same amount (or more) \ref lemon::Timer::stop()
1.14 + ///"stop()"s. This can be useful e.g. to compute the running time
1.15 ///of recursive functions.
1.16 - ///
1.17
1.18 ///@{
1.19
1.20 @@ -472,7 +471,7 @@
1.21 ///@}
1.22 };
1.23
1.24 - ///Same as \ref Timer but prints a report on destruction.
1.25 + ///Same as Timer but prints a report on destruction.
1.26
1.27 ///Same as \ref Timer but prints a report on destruction.
1.28 ///This example shows its usage.
1.29 @@ -491,22 +490,22 @@
1.30 std::string _title;
1.31 std::ostream &_os;
1.32 public:
1.33 - ///\e
1.34 + ///Constructor
1.35
1.36 + ///Constructor.
1.37 ///\param title This text will be printed before the ellapsed time.
1.38 ///\param os The stream to print the report to.
1.39 ///\param run Sets whether the timer should start immediately.
1.40 -
1.41 TimeReport(std::string title,std::ostream &os=std::cerr,bool run=true)
1.42 : Timer(run), _title(title), _os(os){}
1.43 - ///\e Prints the ellapsed time on destruction.
1.44 + ///Destructor that prints the ellapsed time
1.45 ~TimeReport()
1.46 {
1.47 _os << _title << *this << std::endl;
1.48 }
1.49 };
1.50
1.51 - ///'Do nothing' version of \ref TimeReport
1.52 + ///'Do nothing' version of TimeReport
1.53
1.54 ///\sa TimeReport
1.55 ///