From 9149c0ec1d50cb5f6bc4ff2922728bd23724bac7 Mon Sep 17 00:00:00 2001 From: bangerth Date: Wed, 15 Aug 2007 04:31:12 +0000 Subject: [PATCH] Fix outdated doxygen tags git-svn-id: https://svn.dealii.org/trunk@14955 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/deal.II/include/fe/mapping_q1.h | 30 ++++++++++---------- deal.II/deal.II/include/grid/tria_boundary.h | 10 +++---- deal.II/examples/step-26/step-26.cc | 18 ++++++------ 3 files changed, 29 insertions(+), 29 deletions(-) diff --git a/deal.II/deal.II/include/fe/mapping_q1.h b/deal.II/deal.II/include/fe/mapping_q1.h index 69298495e7..875f355a0c 100644 --- a/deal.II/deal.II/include/fe/mapping_q1.h +++ b/deal.II/deal.II/include/fe/mapping_q1.h @@ -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 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 cell and returns + * p_real. */ virtual Point transform_unit_to_real_cell ( @@ -156,37 +156,37 @@ class MappingQ1 : public Mapping * Description of effects if * @p flags contains: *
    - *
  • p{update_q_points} is + *
  • update_q_points is * copied to the output to * compute the quadrature points * on the real cell. - *
  • p{update_JxW_values} is + *
  • update_JxW_values is * copied and requires * @p update_boundary_forms on * faces. The latter, because the * surface element is just the * norm of the boundary form. - *
  • p{update_normal_vectors} + *
  • update_normal_vectors * is copied and requires * @p update_boundary_forms. The * latter, because the normal * vector is the normalized * boundary form. *
  • - * p{update_covariant_transformation} + * update_covariant_transformation * is copied and requires * @p update_contravariant_transformation, * since it is computed as the * inverse of the latter. - *
  • p{update_JxW_values} is + *
  • update_JxW_values is * copied and requires - * @p update_contravariant_transformation, + * update_contravariant_transformation, * since it is computed as one * over determinant of the * latter. - *
  • p{update_boundary_forms} + *
  • update_boundary_forms * is copied and requires - * @p update_contravariant_transformation, + * update_contravariant_transformation, * since the boundary form is * computed as the contravariant * image of the normal vector to diff --git a/deal.II/deal.II/include/grid/tria_boundary.h b/deal.II/deal.II/include/grid/tria_boundary.h index 94af30b95a..b95a7f27a8 100644 --- a/deal.II/deal.II/include/grid/tria_boundary.h +++ b/deal.II/deal.II/include/grid/tria_boundary.h @@ -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 /** * Gives n=points.size() * 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 /** * Gives n=points.size()=m*m * points that splits the - * p{StraightBoundary} quad into - * (m+1)(m+1) subquads of equal + * StraightBoundary quad into + * $(m+1)(m+1)$ subquads of equal * size. * * Refer to the general diff --git a/deal.II/examples/step-26/step-26.cc b/deal.II/examples/step-26/step-26.cc index a5407761e7..e377457d89 100644 --- a/deal.II/examples/step-26/step-26.cc +++ b/deal.II/examples/step-26/step-26.cc @@ -101,8 +101,8 @@ class PointCloudSurface : public StraightBoundary<3> /** * Gives n=points.size() * 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 > &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 + * 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. */ Point<3> closest_point (const Point<3> &p) const; private: -- 2.39.5