From 99ea1fccccb8ad0891d108cfa53cc54f0edab63d Mon Sep 17 00:00:00 2001 From: Guido Kanschat Date: Sun, 11 Jan 2004 12:30:05 +0000 Subject: [PATCH] changes for Doxyhen git-svn-id: https://svn.dealii.org/trunk@8303 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/base/include/base/quadrature.h | 2 ++ deal.II/base/include/base/timer.h | 29 ++++++++++++++------------ 2 files changed, 18 insertions(+), 13 deletions(-) diff --git a/deal.II/base/include/base/quadrature.h b/deal.II/base/include/base/quadrature.h index bfaea23998..3fa7d8b7f9 100644 --- a/deal.II/base/include/base/quadrature.h +++ b/deal.II/base/include/base/quadrature.h @@ -70,6 +70,8 @@ * necessary to provide a class Point@<0@> to make the compiler * happy. This class also does nothing. * + * @ref Instantiations: few + * * @author Wolfgang Bangerth, 1998, 1999, 2000 */ template diff --git a/deal.II/base/include/base/timer.h b/deal.II/base/include/base/timer.h index d373e92e2e..39c209bd7c 100644 --- a/deal.II/base/include/base/timer.h +++ b/deal.II/base/include/base/timer.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003 by the deal authors +// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004 by the deal authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -24,11 +24,11 @@ * microsecond. * * - * @sect3{Usage} + * @section TimerUsage Usage * * Use of this class is as you might expect by looking at the member * functions: - * @begin{verbatim} + * @code * Time timer; * timer.start (); * @@ -41,13 +41,16 @@ * * // reset timer for the next thing it shall do * timer.reset(); - * @end{verbatim} + * @endcode * * Alternatively, you can also restart the timer instead of resetting - * it. The times between successive calls to start/stop will then be + * it. The times between successive calls to start()/ stop() will then be * accumulated. * - * Note: the implementation of this class is system dependent. + * @note Implementation of this class is system + * dependent. Unfortunately, it does not work with multithreading + * right now. In this case, we would like to sum up the time needed by + * all children. Furthermore, a wall clock option would be nice. * * @author G. Kanschat, W. Bangerth */ @@ -92,22 +95,22 @@ class Timer private: /** - * Value of the user time when start + * Value of the user time when start() * was called the last time or when the - * object was created and no stop was + * object was created and no stop() was * issued in between. */ double start_time; /** - * Similar to start_time, but + * Similar to #start_time, but * needed for children threads * in multithread mode. Value of - * the user time when start + * the user time when start() * was called the last time or * when the object was created - * and no stop was issued in + * and no stop() was issued in * between. * * For some reason (error in @@ -116,7 +119,7 @@ class Timer * getrusage(RUSAGE_CHILDREN,.) * gives always 0 (at least * on Solaris7). Hence the - * Timer class still does not + * Timer class still does not * yet work for multithreading * mode. */ @@ -124,7 +127,7 @@ class Timer /** * Accumulated time for all previous - * start/stop cycles. The time for + * start()/stop() cycles. The time for * the present cycle is not included. */ double cumulative_time; -- 2.39.5