From: guido Date: Sun, 24 Jul 2005 21:08:32 +0000 (+0000) Subject: @section etc. removed from documentation X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=27a6afb29f352ce64e768d75a3530915b7e6b9f0;p=dealii-svn.git @section etc. removed from documentation git-svn-id: https://svn.dealii.org/trunk@11186 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/base/include/base/exceptions.h b/deal.II/base/include/base/exceptions.h index f0d04f011e..0010c5f5c0 100644 --- a/deal.II/base/include/base/exceptions.h +++ b/deal.II/base/include/base/exceptions.h @@ -32,15 +32,14 @@ /** - * This class should be used as a base class for - * all exception classes. Do not use its methods - * and variables directly since the interface - * and mechanism may be subject to change. Rather - * create new exception classes using the - * DeclException macro family. + * This class should be used as a base class for all exception + * classes. Do not use its methods and variables directly since the + * interface and mechanism may be subject to change. Rather create + * new exception classes using the DeclException macro + * family. * * - * @section ExceptionBase General General overview of the exception handling mechanism in deal.II + *

General overview of the exception handling mechanism in deal.II

* * The error handling mechanism in deal.II is generally used in two ways. * The first uses error checking in debug mode only and is useful for programs @@ -91,7 +90,7 @@ * declare different classes for each of these. * * - * @section ExceptionBaseUse Use of the debug mode exceptions + *

Use of the debug mode exceptions

* * To use the exception mechanism for debug mode error checking, write lines * like the following in your source code: @@ -116,7 +115,7 @@ * nonetheless to be given with parentheses: * Assert (i>m, ExcSomewhat()); * - * @subsection ExceptionBaseInternal How it works internally + *

How it works internally

* * If the DEBUG preprocessor directive is set, the call Assert * (cond, exc); is basically converted by the preprocessor into the @@ -199,7 +198,7 @@ * message about suppressed follow-up messages is shown. * * - * @section ExceptionBaseUse2 Use of run-time exceptions + *

Use of run-time exceptions

* * For this mode, the standard C++ throw and catch concept exists. We * want to keep to this, but want to extend it a bit. In general, the @@ -258,7 +257,7 @@ * preprocessor variable. * * - * @section ExceptionNMacros Description of the DeclExceptionN macro family + *

Description of the DeclExceptionN macro family

* * Declare an exception class without any additional parameters. * There is a whole family of DeclException? macros diff --git a/deal.II/base/include/base/memory_consumption.h b/deal.II/base/include/base/memory_consumption.h index 373d6aa272..613b3f5e45 100644 --- a/deal.II/base/include/base/memory_consumption.h +++ b/deal.II/base/include/base/memory_consumption.h @@ -65,7 +65,7 @@ * v[i].memory_consumption(). * * - * @section MeMoryConsumptionExt Extending this namespace + *

Extending this namespace

* * The functions in this namespace and the functionality provided by * it live on the assumption that there is either a function diff --git a/deal.II/base/include/base/quadrature.h b/deal.II/base/include/base/quadrature.h index 5bd8cb18ab..af45cce0fa 100644 --- a/deal.II/base/include/base/quadrature.h +++ b/deal.II/base/include/base/quadrature.h @@ -24,19 +24,19 @@ /*@{*/ /** - * Base class for quadrature formulae in arbitrary dimensions. This class + * Base class for quadrature formulæ in arbitrary dimensions. This class * stores quadrature points and weights on the unit line [0,1], unit * square [0,1]x[0,1], etc. * * There are a number of derived classes, denoting concrete - * integration formulae. Their names names prefixed by + * integration formulæ. Their names names prefixed by * Q. Refer to the list of derived classes for more details. * * The schemes for higher dimensions are tensor products of the - * one-dimansional formulae. Therefore, a three-dimensional 5-point + * one-dimansional formulæ. Therefore, a three-dimensional 5-point * Gauss formula has 125 quadrature points. * - * @section QuadratureBlaBla Mathematical background + *

Mathematical background

* * For each quadrature formula we denote by m, the maximal * degree of polynomials integrated exactly. This number is given in @@ -44,20 +44,20 @@ * error is m+1, that is, the error is the size of the cell * two the m+1 by the Bramble-Hilbert Lemma. The number * m is to be found in the documentation of each concrete - * formula. For the optimal formulae QGauss we have $m = 2N-1$, where + * formula. For the optimal formulæ QGauss we have $m = 2N-1$, where * N is the constructor parameter to QGauss. The tensor product - * formulae are exact on tensor product polynomials of degree + * formulæ are exact on tensor product polynomials of degree * m in each space direction, but they are still only of * m+1st order. * - * @section QuadratureImpl Implementation details + *

Implementation details

* - * Most integration formulae in more than one space dimension are - * tensor products of quadrature formulae in one space dimension, or + * Most integration formulæ in more than one space dimension are + * tensor products of quadrature formulæ in one space dimension, or * more generally the tensor product of a formula in (dim-1) * dimensions and one in one dimension. There is a special constructor * to generate a quadrature formula from two others. For example, the - * QGauss@ formulae include Ndim quadrature + * QGauss@ formulæ include Ndim quadrature * points in dim dimensions, where N is the constructor * parameter of QGauss. * @@ -276,7 +276,7 @@ class QAnisotropic : public Quadrature * of the weights of the left- and the rightmost quadrature point. * * Since all dimensions higher than one are built up by tensor products of - * one dimensional and dim-1 dimensional quadrature formulae, the + * one dimensional and dim-1 dimensional quadrature formulæ, the * argument given to the constructor needs to be a quadrature formula in * one space dimension, rather than in dim dimensions. * diff --git a/deal.II/base/include/base/timer.h b/deal.II/base/include/base/timer.h index 6803b2c3eb..63ee3f0682 100644 --- a/deal.II/base/include/base/timer.h +++ b/deal.II/base/include/base/timer.h @@ -24,7 +24,7 @@ * microsecond. * * - * @section TimerUsage Usage + *

Usage

* * Use of this class is as you might expect by looking at the member * functions: