From: Daniel Arndt Date: Wed, 28 Jun 2017 15:28:18 +0000 (+0200) Subject: Fix documentation X-Git-Tag: v9.0.0-rc1~1462^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=9c55cfb37192f01faf16e4986580975d58cb8e14;p=dealii.git Fix documentation --- diff --git a/doc/news/changes/incompatibilities/20170627DanielArndt b/doc/news/changes/incompatibilities/20170627DanielArndt index 3190f841b2..85e8854ba3 100644 --- a/doc/news/changes/incompatibilities/20170627DanielArndt +++ b/doc/news/changes/incompatibilities/20170627DanielArndt @@ -1,6 +1,4 @@ Changed: Timer::print_data doesn't restrict its output to the first MPI process anymore but leaves such a choice to the stream given. -Timer::get_data returns zero values instead of invalid values if stop() was not -called before.
(Daniel Arndt, 2017/06/27) diff --git a/include/deal.II/base/timer.h b/include/deal.II/base/timer.h index 64dff3e921..da337c0136 100644 --- a/include/deal.II/base/timer.h +++ b/include/deal.II/base/timer.h @@ -167,8 +167,8 @@ public: double wall_time () const; /** - * Access to the wall time for the currently running lap without stopping - * the timer. + * Access to the wall time since the timer has been stopped the last time. + * The timer is not stopped by this function. * The elapsed time is returned in units of seconds. */ double last_wall_time() const; @@ -180,20 +180,18 @@ public: double cpu_time() const; /** - * Access to the wall time for the currently running lap without stopping - * the timer. + * Access to the CPU time since the timer has been stopped the last time. + * The timer is not stopped by this function. * The elapsed time is returned in units of seconds. */ double last_cpu_time() const; /** - * Return the last lap time; the time taken between the last - * start()/stop() - * call. + * Returns the wall time taken between the last start()/stop() call. * * @deprecated Use last_wall_time() instead. */ - double get_lap_time () const; + double get_lap_time () const DEAL_II_DEPRECATED; private: @@ -235,12 +233,12 @@ private: double cumulative_wall_time; /** - * Stores the last lap wall time; the time between the last start()/stop() cycle. + * Stores the wall time between the last start()/stop() cycle. */ double last_lap_time; /** - * Stores the last lap cpu time; the time between the last start()/stop() cycle. + * Stores the CPU time between the last start()/stop() cycle. */ double last_lap_cpu_time;