]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Fix outdated doxygen tags
authorbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 15 Aug 2007 04:31:12 +0000 (04:31 +0000)
committerbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 15 Aug 2007 04:31:12 +0000 (04:31 +0000)
git-svn-id: https://svn.dealii.org/trunk@14955 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/include/fe/mapping_q1.h
deal.II/deal.II/include/grid/tria_boundary.h
deal.II/examples/step-26/step-26.cc

index 69298495e761dff1649926a563ef897346967a57..875f355a0cb740f36d736a3d1d1f2e25b9a494df 100644 (file)
@@ -2,7 +2,7 @@
 //    $Id$
 //    Version: $Name$
 //
-//    Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006 by the deal.II authors
+//    Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 by the deal.II authors
 //
 //    This file is subject to QPL and may not be  distributed
 //    without copyright and license information. Please refer
@@ -34,12 +34,12 @@ DEAL_II_NAMESPACE_OPEN
  * functions.
  *
  * This function maps the unit cell to a general grid cell with
- * straight lines in @p d dimensions (remark that in 3D the surfaces
+ * straight lines in $d$ dimensions (remark that in 3D the surfaces
  * may be curved, even if the edges are not). This is the well-known
  * mapping for polyhedral domains.
  *
  * Shape function for this mapping are the same as for the finite
- * element @p FE_Q of order 1. Therefore, coupling these two yields
+ * element FE_Q of order 1. Therefore, coupling these two yields
  * an isoparametric element.
  *
  * @author Guido Kanschat, 2000, 2001; Ralf Hartmann, 2000, 2001, 2005
@@ -54,10 +54,10 @@ class MappingQ1 : public Mapping<dim>
     MappingQ1 ();
     
                                     /**
-                                     * Transforms the point @p p on
-                                     * the unit cell to the point
-                                     * @p p_real on the real cell
-                                     * @p cell and returns @p p_real.
+                                     * Transforms the point p on the unit
+                                     * cell to the point p_real on the real
+                                     * cell <code>cell</code> and returns
+                                     * p_real.
                                      */
     virtual Point<dim>
     transform_unit_to_real_cell (
@@ -156,37 +156,37 @@ class MappingQ1 : public Mapping<dim>
                                      * Description of effects if
                                      * @p flags contains:
                                      * <ul>
-                                     * <li> p{update_q_points} is
+                                     * <li> <code>update_q_points</code> is
                                      * copied to the output to
                                      * compute the quadrature points
                                      * on the real cell.
-                                     * <li> p{update_JxW_values} is
+                                     * <li> <code>update_JxW_values</code> is
                                      * copied and requires
                                      * @p update_boundary_forms on
                                      * faces. The latter, because the
                                      * surface element is just the
                                      * norm of the boundary form.
-                                     * <li> p{update_normal_vectors}
+                                     * <li> <code>update_normal_vectors</code>
                                      * is copied and requires
                                      * @p update_boundary_forms. The
                                      * latter, because the normal
                                      * vector is the normalized
                                      * boundary form.
                                      * <li>
-                                     * p{update_covariant_transformation}
+                                     * <code>update_covariant_transformation</code>
                                      * is copied and requires
                                      * @p update_contravariant_transformation,
                                      * since it is computed as the
                                      * inverse of the latter.
-                                     * <li> p{update_JxW_values} is
+                                     * <li> <code>update_JxW_values</code> is
                                      * copied and requires
-                                     * @p update_contravariant_transformation,
+                                     * <code>update_contravariant_transformation</code>,
                                      * since it is computed as one
                                      * over determinant of the
                                      * latter.
-                                     * <li> p{update_boundary_forms}
+                                     * <li> <code>update_boundary_forms</code>
                                      * is copied and requires
-                                     * @p update_contravariant_transformation,
+                                     * <code>update_contravariant_transformation</code>,
                                      * since the boundary form is
                                      * computed as the contravariant
                                      * image of the normal vector to
index 94af30b95a5b277c3d2facaf29ee99dae7d0c19d..b95a7f27a8092c1453a64daeb5a453af65a7380e 100644 (file)
@@ -2,7 +2,7 @@
 //    $Id$
 //    Version: $Name$
 //
-//    Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 by the deal.II authors
+//    Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 by the deal.II authors
 //
 //    This file is subject to QPL and may not be  distributed
 //    without copyright and license information. Please refer
@@ -313,8 +313,8 @@ class StraightBoundary : public Boundary<dim>
                                     /**
                                      * Gives <tt>n=points.size()</tt>
                                      * points that splits the
-                                     * p{StraightBoundary} line into
-                                     * p{n+1} partitions of equal
+                                     * StraightBoundary line into
+                                     * $n+1$ partitions of equal
                                      * lengths.
                                      *
                                      * Refer to the general
@@ -329,8 +329,8 @@ class StraightBoundary : public Boundary<dim>
                                     /**
                                      * Gives <tt>n=points.size()=m*m</tt>
                                      * points that splits the
-                                     * p{StraightBoundary} quad into
-                                     * <tt>(m+1)(m+1)</tt> subquads of equal
+                                     * StraightBoundary quad into
+                                     * $(m+1)(m+1)$ subquads of equal
                                      * size.
                                      *
                                      * Refer to the general
index a5407761e7eae68c1b42d39aecf98ad60b0a6a08..e377457d89ae7265095bffd04c03a9949ae54078 100644 (file)
@@ -101,8 +101,8 @@ class PointCloudSurface : public StraightBoundary<3>
                                     /**
                                      * Gives <tt>n=points.size()</tt>
                                      * points that splits the
-                                     * p{StraightBoundary} line into
-                                     * p{n+1} partitions of equal
+                                     * StraightBoundary line into
+                                     * $n+1$ partitions of equal
                                      * lengths.
                                      *
                                      * Refer to the general
@@ -131,13 +131,13 @@ class PointCloudSurface : public StraightBoundary<3>
                                     std::vector<Point<3> > &points) const;
 
                                     /**
-                                     * A function that, given a point @p p,
-                                     * returns the closest point on the
-                                     * surface defined by the input file. For
-                                     * the time being, we simply return the
-                                     * closest point in the point cloud,
-                                     * rather than doing any sort of
-                                     * interpolation.
+                                     * A function that, given a point
+                                     * <code>p</code>, returns the closest
+                                     * point on the surface defined by the
+                                     * input file. For the time being, we
+                                     * simply return the closest point in the
+                                     * point cloud, rather than doing any
+                                     * sort of interpolation.
                                      */
     Point<3> closest_point (const Point<3> &p) const;    
   private:

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.