From 9764a684d105fe0affc455a281dc9d4714e53470 Mon Sep 17 00:00:00 2001 From: Timo Heister Date: Thu, 9 Jul 2015 12:55:40 -0400 Subject: [PATCH] fix doxygen errors --- include/deal.II/grid/grid_generator.h | 14 +++++++------- include/deal.II/lac/linear_operator.h | 6 +++--- include/deal.II/lac/vector.h | 2 +- include/deal.II/numerics/error_estimator.h | 12 ++++++------ include/deal.II/numerics/vector_tools.h | 2 +- 5 files changed, 18 insertions(+), 18 deletions(-) diff --git a/include/deal.II/grid/grid_generator.h b/include/deal.II/grid/grid_generator.h index 33e263efaa..183c8c3e6a 100644 --- a/include/deal.II/grid/grid_generator.h +++ b/include/deal.II/grid/grid_generator.h @@ -79,16 +79,16 @@ namespace GridGenerator /** * \brief Mesh of a d-simplex with (d+1) vertices and mesh cells, resp. * - * The vertices argument contains a vector with all d+1 - * vertices of the simplex. They must be given in an order such that + * The @p vertices argument contains a vector with all d+1 vertices + * of the simplex. They must be given in an order such that * the vectors from the first vertex to each of the others form a * right-handed system. And I am not happy about the discrimination * involved here. * * The meshes generated in two and three dimensions are * - * @image simplex_2d.png - * @image simplex_3d.png + * @image html simplex_2d.png + * @image html simplex_3d.png * * @author Guido Kanschat * @date 2015 @@ -237,7 +237,7 @@ namespace GridGenerator * * An example with two by three holes is * - * @image cheese_2d.png + * @image html cheese_2d.png * * @author Guido Kanschat * @date 2015 @@ -458,8 +458,8 @@ namespace GridGenerator * * Examples in two and three dimensions are * - * @image hyper_cross_2d.png - * @image hyper_cross_3d.png + * @image html hyper_cross_2d.png + * @image html hyper_cross_3d.png * * @author Guido Kanschat * @date 2015 diff --git a/include/deal.II/lac/linear_operator.h b/include/deal.II/lac/linear_operator.h index ecdc0fe3bb..1950dd7820 100644 --- a/include/deal.II/lac/linear_operator.h +++ b/include/deal.II/lac/linear_operator.h @@ -303,7 +303,7 @@ public: * @relates LinearOperator * * Addition of two linear operators @p first_op and @p second_op given by - * $(\text{first\_op}+\text{second\_op})x:=\text{first\_op}(x)+\text{second\_op}(x)$ + * $(\text{first\_op}+\text{second\_op})x := \text{first\_op}(x) + \text{second\_op}(x)$ * * @ingroup LAOperators */ @@ -363,7 +363,7 @@ operator+(const LinearOperator &first_op, * @relates LinearOperator * * Subtraction of two linear operators @p first_op and @p second_op given by - * $(\text{first\_op}-\text{second\_op})x:=\text{first\_op}(x)-\text{second\_op}(x)$ + * $(\text{first\_op}-\text{second\_op})x := \text{first\_op}(x) - \text{second\_op}(x)$ * * @ingroup LAOperators */ @@ -499,7 +499,7 @@ operator*(const LinearOperator &op, * @relates LinearOperator * * Composition of two linear operators @p first_op and @p second_op given by - * $(\text{first\_op}*\text{second\_op})x:=\text{first\_op}(\text{second\_op}(x))$ + * $(\text{first\_op}*\text{second\_op})x := \text{first\_op}(\text{second\_op}(x))$ * * @ingroup LAOperators */ diff --git a/include/deal.II/lac/vector.h b/include/deal.II/lac/vector.h index f80c0a2e78..3d8538268e 100644 --- a/include/deal.II/lac/vector.h +++ b/include/deal.II/lac/vector.h @@ -665,7 +665,7 @@ public: /** * Simple vector addition, equal to the operator +=. * - * @deprecate Use the operator += instead. + * @deprecated Use the operator += instead. * * @dealiiOperationIsMultithreaded */ diff --git a/include/deal.II/numerics/error_estimator.h b/include/deal.II/numerics/error_estimator.h index f0be09f769..bb6141468f 100644 --- a/include/deal.II/numerics/error_estimator.h +++ b/include/deal.II/numerics/error_estimator.h @@ -98,7 +98,7 @@ namespace hp * Ainsworth $ c_F=\frac h{24} $, but this factor is a bit esoteric, * stemming from interpolation estimates and stability constants which may * hold for the Poisson problem, but may not hold for more general situations. - * Alternatively, we consider the case when $ c_F=\frac {h_F}_{2p_F} $, + * Alternatively, we consider the case when $ c_F=\frac {h_F}{2p_F} $, * where $ h_F $ is face diagonal and $ p_F=max(p^+,p^-) $ is the * maximum polynomial degree of adjacent elements. The choice between the two is * done by means of the enumerator, provided as the last argument in all functions. @@ -124,9 +124,9 @@ namespace hp * in the second loop. By doing so we avoid problems to decide with which $h$ * to multiply, that of the cell on the one or that of the cell on the other * side of the face. Whereas for the hp-estimator the @p map stores integrals - * multiplied by $\frac {h_f}_{2p_f}$, which are then summed in the second loop. + * multiplied by $\frac {h_F}{2p_F}$, which are then summed in the second loop. * - * $h$ ($h_f$) is taken to be the greatest length of the diagonals of the cell (face). + * $h$ ($h_F$) is taken to be the greatest length of the diagonals of the cell (face). * For more or less uniform cells (faces) without deformed angles, this coincides * with the diameter of the cell (face). * @@ -178,7 +178,7 @@ namespace hp *
  • The face belongs to a Neumann boundary. In this case, the * contribution of the face $F\in\partial K$ looks like \f[ n_F\int_F * \left|g-a\frac{\partial u_h}{\partial n}\right|^2 ds \f] where $g$ is the - * Neumann boundary function, $n_F=\frac h_{24}$ and $n_F=\frac {h_F}{p}$ for + * Neumann boundary function, $n_F=\frac {h}{24}$ and $n_F=\frac {h_F}{p}$ for * the Kelly and hp-estimator, respectively. * If the finite element is vector-valued, then * obviously the function denoting the Neumann boundary conditions needs to be @@ -260,9 +260,9 @@ public: */ enum Strategy { - //! Kelly error estimator with the factor $\frac h_{24}$. + //! Kelly error estimator with the factor $\frac {h}{24}$. cell_diameter_over_24 = 0, - //! the boundary residual estimator with the factor $\frac {h_F}_{2 max(p^+,p^-)$. + //! the boundary residual estimator with the factor $\frac {h_F}{2 max(p^+,p^-)}$. face_diameter_over_twice_max_degree }; diff --git a/include/deal.II/numerics/vector_tools.h b/include/deal.II/numerics/vector_tools.h index 3325d80644..6f88c53d08 100644 --- a/include/deal.II/numerics/vector_tools.h +++ b/include/deal.II/numerics/vector_tools.h @@ -1157,7 +1157,7 @@ namespace VectorTools * * $c_{i} = \int_{f} (\vec{n} \times \vec{r}) \cdot (\vec{n} \times \vec{s}_i) dS$ * - * and $\vec{r} = \vec{F} - \sum_{e \in f} \sum{i \in e} \x_{i}\vec{s}_i}$, the edge residual. + * and $\vec{r} = \vec{F} - \sum_{e \in f} \sum{i \in e} x_{i}\vec{s}_i$, the edge residual. * * The resulting constraints are then given in the solutions $x$ and $y$. * -- 2.39.5