]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
More for doxygen.
authorwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Mon, 19 Apr 2004 16:41:43 +0000 (16:41 +0000)
committerwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Mon, 19 Apr 2004 16:41:43 +0000 (16:41 +0000)
git-svn-id: https://svn.dealii.org/trunk@9053 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/include/dofs/dof_handler.h
deal.II/deal.II/include/dofs/dof_levels.h
deal.II/deal.II/include/fe/fe_values.h
deal.II/deal.II/include/fe/mapping.h
deal.II/deal.II/include/grid/tria.h
deal.II/deal.II/include/grid/tria_levels.h
deal.II/deal.II/include/numerics/derivative_approximation.h
deal.II/deal.II/include/numerics/error_estimator.h
deal.II/deal.II/include/numerics/matrices.h

index 23cdbc5c09e1051e889edaeb801a7440baf64dff..44ae5b907d35f607a84abf96f5a09ecda478f738 100644 (file)
@@ -57,7 +57,7 @@ class DoFDimensionInfo
 /**
  * Define some types for the DoF handling in one dimension.
  *
- * The types have the same meaning as those declared in @ref{TriaDimensionInfo<2>}.
+ * The types have the same meaning as those declared in TriaDimensionInfo<2>.
  *
  * @author Wolfgang Bangerth, 1998
  */
@@ -91,7 +91,7 @@ class DoFDimensionInfo<1>
 /**
  * Define some types for the DoF handling in two dimensions.
  *
- * The types have the same meaning as those declared in @ref{TriaDimensionInfo<2>}.
+ * The types have the same meaning as those declared in TriaDimensionInfo<2>.
  *
  * @author Wolfgang Bangerth, 1998
  */
@@ -125,7 +125,7 @@ class DoFDimensionInfo<2>
 /**
  * Define some types for the DoF handling in two dimensions.
  *
- * The types have the same meaning as those declared in @ref{TriaDimensionInfo<3>}.
+ * The types have the same meaning as those declared in TriaDimensionInfo<3>.
  *
  * @author Wolfgang Bangerth, 1998
  */
index 80e9e6964ed0e09af03b4442645e20895762ce26..c587d38a1581e3bfe87b3aca05be9a289c2fc7c3 100644 (file)
@@ -112,7 +112,7 @@ class DoFLevel<1>
 
 /**
  * Store the indices of the degrees of freedom which are located on
- * quads.  See @ref{DoFLevel<1>} for more information.
+ * quads.  See DoFLevel<1> for more information.
  *
  * @author Wolfgang Bangerth, 1998
  */
@@ -140,7 +140,7 @@ class DoFLevel<2> : public DoFLevel<1>
 
 /**
  * Store the indices of the degrees of freedom which are located on
- * hexhedra.  See @ref{DoFLevel<1>} for more information.
+ * hexhedra.  See DoFLevel<1> for more information.
  *
  * @author Wolfgang Bangerth, 1998
  */
index dc8ac9aa4a18deeb65f5d137fb4442dcc213d9e9..7a411f215cc53f11276aa00552c64cc6691d593f 100644 (file)
@@ -961,7 +961,7 @@ class FEValues : public FEValuesBase<dim>
              const UpdateFlags         update_flags);
 
                                      /**
-                                     * Constructor. Uses @ref{MappingQ1}
+                                     * Constructor. Uses MappingQ1
                                      * implicitly.
                                      */
     FEValues (const FiniteElement<dim> &fe,
@@ -1139,7 +1139,7 @@ class FEFaceValues : public FEFaceValuesBase<dim>
                  const UpdateFlags update_flags);
 
                                      /**
-                                     * Constructor. Uses @ref{MappingQ1}
+                                     * Constructor. Uses MappingQ1
                                      * implicitly.
                                      */
     FEFaceValues (const FiniteElement<dim>& fe,
@@ -1199,7 +1199,7 @@ class FESubfaceValues : public FEFaceValuesBase<dim>
                     const UpdateFlags update_flags);
 
                                      /**
-                                     * Constructor. Uses @ref{MappingQ1}
+                                     * Constructor. Uses MappingQ1
                                      * implicitly.
                                      */
     FESubfaceValues (const FiniteElement<dim>& fe,
index bf9c937d03f902a915a462378e2762fc1cd4ff7f..e6ca902b5cec7570e96669132e8e46a9220d9b50 100644 (file)
@@ -363,7 +363,7 @@ class Mapping : public Subscriptor
                                      * further information.
                                      *
                                      * Example: refer to the same
-                                     * function in @ref{MappingQ1}.
+                                     * function in MappingQ1.
                                      */
     virtual UpdateFlags update_once (const UpdateFlags) const = 0;
     
index f39e52fd0d7920637a35c36591a4994727d62b03..0257ee3cb92c04256853a53264de9c18bbec3456 100644 (file)
@@ -514,7 +514,7 @@ struct TriaNumberCache<1>
  * Cache class used to store the number of used and active elements
  * (lines or quads etc) within the levels of a triangulation. This
  * specialization stores the numbers of quads. Due to the inheritance
- * from the base class @ref{TriaNumberCache<1>}, the numbers of lines
+ * from the base class TriaNumberCache<1>, the numbers of lines
  * are also within this class.
  *
  * In the old days, whenever one wanted to access one of these
@@ -574,7 +574,7 @@ struct TriaNumberCache<2> : public TriaNumberCache<1>
  * Cache class used to store the number of used and active elements
  * (lines or quads etc) within the levels of a triangulation. This
  * specialization stores the numbers of hexes. Due to the inheritance
- * from the base class @ref{TriaNumberCache<2>}, the numbers of lines
+ * from the base class TriaNumberCache<2>, the numbers of lines
  * and quads are also within this class.
  *
  * In the old days, whenever one wanted to access one of these
@@ -1688,7 +1688,7 @@ struct TriaNumberCache<3> : public TriaNumberCache<2>
  *   <li> Face 4: children 3, 2, 6, 7;
  *   <li> Face 5: children 0, 4, 7, 3.
  *   </ul>
- *   You can get these numbers using the @ref{GeometryInfo<3>}@p ::child_cell_on_face
+ *   You can get these numbers using the GeometryInfo<3>@p ::child_cell_on_face
  *   function. Each child is adjacent to the vertex with the same number.
  *
  *   Note that, again, the above list only holds for faces in their
index 5ff70654848aed894532310eaababffe05ad41d0..fd39a5505125a436ebfe8cd0fd78d58846e83ef9 100644 (file)
@@ -36,7 +36,7 @@ class TriangulationLevel
 /**
  *  Store all information which belongs to one level of the multilevel hierarchy.
  *
- *  In @ref{TriangulationLevel<0>} all data is stored which is not
+ *  In TriangulationLevel<0> all data is stored which is not
  *  dependent on the dimension, e.g. a field to store the
  *  refinement flag for the cells (what a cell actually is
  *  is declared elsewhere), etc. Actually, it is only cell-based
@@ -322,7 +322,7 @@ class TriangulationLevel<1> : public TriangulationLevel<0>
                                      *  between the number of new quads and
                                      *  the number of new lines, etc.). Also
                                      *  don't forget to call the
-                                     *  @ref{TriangulationLevel<0>}@p ::reserve_space
+                                     *  TriangulationLevel<0>@p ::reserve_space
                                      *  function.
                                      */
     void reserve_space (const unsigned int new_lines);
@@ -355,7 +355,7 @@ class TriangulationLevel<1> : public TriangulationLevel<0>
  *  information about the children of these lines and quads.
  *
  *  The vector of lines and their children is derived from
- *  @ref{TriangulationLevel<1>}.
+ *  TriangulationLevel<1>.
  *
  *  @author Wolfgang Bangerth, 1998
  */
@@ -368,7 +368,7 @@ class TriangulationLevel<2> :  public TriangulationLevel<1>
                                      *  level.
                                      *
                                      *  It is fully analogous to the
-                                     *  @ref{TriangulationLevel<1>::LinesData} structure inherited from
+                                     *  TriangulationLevel<1>::LinesData structure inherited from
                                      *  Triangulation<tt><1></tt>.
                                      */
     struct QuadsData
@@ -379,7 +379,7 @@ class TriangulationLevel<2> :  public TriangulationLevel<1>
        std::vector<Quad> quads;
                                         /**
                                          *  Same as for the
-                                         *  @ref{TriangulationLevel<1>::LinesData}@p ::chilren
+                                         *  TriangulationLevel<1>::LinesData@p ::chilren
                                          *  array, but since there
                                          *  are four children, the
                                          *  index points to the first
@@ -391,13 +391,13 @@ class TriangulationLevel<2> :  public TriangulationLevel<1>
 
                                         /**
                                          *  Same as for
-                                         *  @ref{TriangulationLevel<1>::LinesData}@p ::used.
+                                         *  TriangulationLevel<1>::LinesData@p ::used.
                                          */
        std::vector<bool> used;
 
                                         /**
                                          *  Same as for
-                                         *  @ref{TriangulationLevel<1>::LinesData}@p ::used.
+                                         *  TriangulationLevel<1>::LinesData@p ::used.
                                          */
        std::vector<bool> user_flags;
 
@@ -477,7 +477,7 @@ class TriangulationLevel<2> :  public TriangulationLevel<1>
  *  Triangulation class) or in the opposite direction.
  *
  *  The vectors of lines and quads and their children are derived from
- *  @ref{TriangulationLevel<2>}.
+ *  TriangulationLevel<2>.
  *
  *  @author Wolfgang Bangerth, 1998, 2003
  */
@@ -491,9 +491,9 @@ class TriangulationLevel<3> :  public TriangulationLevel<2>
                                      *  level.
                                      *
                                      *  It is fully analogous to the
-                                     *  @ref{TriangulationLevel<1>::LinesData}
+                                     *  TriangulationLevel<1>::LinesData
                                      *  structure inherited from
-                                     *  @ref{Triangulation<1>}.
+                                     *  Triangulation<1>.
                                      */
     struct HexesData
     {
@@ -504,7 +504,7 @@ class TriangulationLevel<3> :  public TriangulationLevel<2>
         
                                         /**
                                          *  Same as for the
-                                         *  @ref{TriangulationLevel<1>::LinesData}@p ::chilren
+                                         *  TriangulationLevel<1>::LinesData@p ::chilren
                                          *  array, but since there
                                          *  are four children, the
                                          *  index points to the first
@@ -516,13 +516,13 @@ class TriangulationLevel<3> :  public TriangulationLevel<2>
 
                                         /**
                                          *  Same as for
-                                         *  @ref{TriangulationLevel<1>::LinesData}@p ::used.
+                                         *  TriangulationLevel<1>::LinesData@p ::used.
                                          */
        std::vector<bool> used;
 
                                         /**
                                          *  Same as for
-                                         *  @ref{TriangulationLevel<1>::LinesData}@p ::used.
+                                         *  TriangulationLevel<1>::LinesData@p ::used.
                                          */
        std::vector<bool> user_flags;
 
index 06258464bb19f77668010b68e620f9b16a044c08..bc098efe0a61c5565ad55db8bdbf04805b4ff20e 100644 (file)
@@ -75,7 +75,7 @@
  * the values of the finite element field at the centers of the cells
  * are taken. It might therefore only be useful to use this class for
  * discontinuous, piecewise constant elements (i.e. using the
- * @ref{FEDG_Q0} class), since all other finite elements can approximate
+ * FEDG_Q0 class), since all other finite elements can approximate
  * gradients themselves.
  *
  *
index 5d6ba134a91162c67f883db8b38416b1091399e0..8cc8b3f5fe4ecbfcbaa39dcba089e0e9c89c25c2 100644 (file)
@@ -78,7 +78,7 @@ template <int dim> class FESubfaceValues;
  *  square of the jumps) of each cell and take the square root.
  *
  *  The integration is done using a quadrature formula on the face.
- *  For linear trial functions (@ref{FEQ1}), the @ref{QGauss2} or even the
+ *  For linear trial functions (FEQ1), the QGauss2 or even the
  *  QMidpoint rule will suffice. For higher order elements, it is
  *  necessary to utilize higher order quadrature formulae as well.
  *
index 5229c350c79921fb1184a130cab003c1f8b4e97c..a2d1a8a2f86fd29d5d535508275ac947151bd486 100644 (file)
@@ -56,10 +56,10 @@ namespace PETScWrappers
  *
  * There exist two versions of each function. One with a Mapping
  * argument and one without. If a code uses a mapping different from
- * @ref{MappingQ1} the functions <em>with</em> mapping argument should
- * be used. Code that uses only @ref{MappingQ1} may also use the
+ * MappingQ1 the functions <em>with</em> mapping argument should
+ * be used. Code that uses only MappingQ1 may also use the
  * functions <em>without</em> Mapping argument. Each of these
- * latter functions create a @ref{MappingQ1} object and just call the
+ * latter functions create a MappingQ1 object and just call the
  * respective functions with that object as mapping argument. The
  * functions without Mapping argument still exist to ensure
  * backward compatibility. Nevertheless it is advised to change the
@@ -67,7 +67,7 @@ namespace PETScWrappers
  * the functions that take this @p Mapping object as argument. This
  * gives the possibility to easily extend the user codes to work also
  * on mappings of higher degree, this just by exchanging
- * @ref{MappingQ1} by, for example, a MappingQ or another
+ * MappingQ1 by, for example, a MappingQ or another
  * Mapping object of interest.
  *
  * All functions take a sparse matrix object to hold the matrix to be

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.