]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
@section etc. removed from documentation
authorguido <guido@0785d39b-7218-0410-832d-ea1e28bc413d>
Sun, 24 Jul 2005 21:08:32 +0000 (21:08 +0000)
committerguido <guido@0785d39b-7218-0410-832d-ea1e28bc413d>
Sun, 24 Jul 2005 21:08:32 +0000 (21:08 +0000)
git-svn-id: https://svn.dealii.org/trunk@11186 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/base/include/base/exceptions.h
deal.II/base/include/base/memory_consumption.h
deal.II/base/include/base/quadrature.h
deal.II/base/include/base/timer.h

index f0d04f011eaadbcf805013a0538d81bccf46c569..0010c5f5c0f302929c2ba79096296e343b4a54e1 100644 (file)
 
 
 /**
- *  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
- *  <tt>DeclException</tt> 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 <tt>DeclException</tt> macro
+ *  family.
  *
  *
- *  @section ExceptionBase General General overview of the exception handling mechanism in deal.II
+ *  <h3>General overview of the exception handling mechanism in deal.II</h3>
  *
  *  The error handling mechanism in <tt>deal.II</tt> 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
+ *  <h3>Use of the debug mode exceptions</h3>
  *
  *  To use the exception mechanism for debug mode error checking, write lines
  *  like the following in your source code:
  *  nonetheless to be given with parentheses:
  *  <tt>Assert (i>m, ExcSomewhat());</tt>
  *
- *  @subsection ExceptionBaseInternal How it works internally
+ *  <h4>How it works internally</h4>
  *
  *  If the <tt>DEBUG</tt> preprocessor directive is set, the call <tt>Assert
  *  (cond, exc);</tt> is basically converted by the preprocessor into the
  *  message about suppressed follow-up messages is shown.
  *
  *
- *  @section ExceptionBaseUse2 Use of run-time exceptions
+ *  <h3>Use of run-time exceptions</h3>
  *
  *  For this mode, the standard <tt>C++</tt> <tt>throw</tt> and <tt>catch</tt> concept exists. We
  *  want to keep to this, but want to extend it a bit. In general, the
  *  preprocessor variable.
  *
  *
- *  @section ExceptionNMacros Description of the DeclExceptionN macro family
+ *  <h3>Description of the DeclExceptionN macro family</h3>
  *
  *  Declare an exception class without any additional parameters.
  *  There is a whole family of <tt>DeclException?</tt> macros
index 373d6aa272762dd9d6a65fa16e272b07730640fa..613b3f5e45d8b41d9ae68289c9943e52f52aadfa 100644 (file)
@@ -65,7 +65,7 @@
  * <tt>v[i].memory_consumption()</tt>.
  *
  *
- * @section MeMoryConsumptionExt Extending this namespace
+ * <h3>Extending this namespace</h3>
  *
  * The functions in this namespace and the functionality provided by
  * it live on the assumption that there is either a function
index 5bd8cb18ab7b2f0243e6ded85c7c210691df5ab9..af45cce0facb174225a7320c5004acb42423b6a9 100644 (file)
 /*@{*/
 
 /**
- * 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
  * <tt>Q</tt>. 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
+ * <h3>Mathematical background</h3>
  *
  * For each quadrature formula we denote by <tt>m</tt>, the maximal
  * degree of polynomials integrated exactly. This number is given in
  * error is <tt>m+1</tt>, that is, the error is the size of the cell
  * two the <tt>m+1</tt> by the Bramble-Hilbert Lemma. The number
  * <tt>m</tt> 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
  * <tt>m</tt> in each space direction, but they are still only of
  * <tt>m+1</tt>st order.
  *
- * @section QuadratureImpl Implementation details
+ * <h3>Implementation details</h3>
  *
- * 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 <tt>(dim-1)</tt>
  * dimensions and one in one dimension. There is a special constructor
  * to generate a quadrature formula from two others.  For example, the
- * QGauss@<dim@> formulae include <i>N<sup>dim</sup></i> quadrature
+ * QGauss@<dim@> formulæ include <i>N<sup>dim</sup></i> quadrature
  * points in <tt>dim</tt> dimensions, where N is the constructor
  * parameter of QGauss.
  *
@@ -276,7 +276,7 @@ class QAnisotropic : public Quadrature<dim>
  * 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 <tt>dim-1</tt> dimensional quadrature formulae, the
+ * one dimensional and <tt>dim-1</tt> dimensional quadrature formulæ, the
  * argument given to the constructor needs to be a quadrature formula in
  * one space dimension, rather than in <tt>dim</tt> dimensions.
  *
index 6803b2c3eb4811655c2f1fcdb48565d314fc4faa..63ee3f0682c045a85b06f19e06c5935242dd512c 100644 (file)
@@ -24,7 +24,7 @@
  * microsecond. 
  *
  *
- * @section TimerUsage Usage
+ * <h3>Usage</h3>
  *
  * Use of this class is as you might expect by looking at the member
  * functions:

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.