]> https://gitweb.dealii.org/ - dealii.git/commitdiff
fix doxygen formula errors
authorTimo Heister <timo.heister@gmail.com>
Tue, 14 May 2019 21:17:56 +0000 (15:17 -0600)
committerTimo Heister <timo.heister@gmail.com>
Tue, 14 May 2019 21:19:00 +0000 (15:19 -0600)
examples/step-32/doc/intro.dox
examples/step-38/doc/intro.dox
include/deal.II/grid/grid_generator.h
include/deal.II/grid/manifold_lib.h
include/deal.II/lac/qr.h
include/deal.II/optimization/solver_bfgs.h

index 8071c67c0c0e88c75d7b51a3c8a39e495caf11a8..d2f56b78821c177aca51900a0c49abcb3a351658 100644 (file)
@@ -1144,7 +1144,7 @@ the following quantities:
   viscosity of the material that flows into the area vacated under the
   rebounding continental plates.
 
-  Using this technique, values around $\eta=10^{21} \text{Pa \thinmuskip s}
+  Using this technique, values around $\eta=10^{21} \text{Pa \; s}
   = 10^{21} \frac{\text{N\; s}}{\text{m}^2}
   = 10^{21} \frac{\text{kg}}{\text{m\; s}}$ have been found as the most
   likely, though the error bar on this is at least one order of magnitude.
index f28962a508794956ef786bcf9f8ab82c53b4d89b..f0dd4307cc2c37240801929565894afbc822ca3a 100644 (file)
@@ -118,7 +118,7 @@ This surface description given, in the codimension one surface case, the two
 routines FEValues::shape_grad and FEValues::JxW
 return
 @f{align*}
-\text{FEValues::shape_grad}(i,l)&=D \mathbf x_K(p_l) G^{-1}(p_l)D(\varphi_i \circ \mathbf x_K)
+\text{FEValues::shape\_grad}(i,l)&=D \mathbf x_K(p_l) G^{-1}(p_l)D(\varphi_i \circ \mathbf x_K)
   (p_l)
 \\
 \text{FEValues::JxW}(l) &=  \sqrt{\det (G(p_l))} \ w_l.
index febb246c8b34575b13522914d8061f620c08fdd1..9c55cf002faad1a43e4cc420bb44a120ffb50441 100644 (file)
@@ -1120,7 +1120,7 @@ namespace GridGenerator
    *
    * @f[
    *     r = r_{\text{inner}} + (r_\text{outer} - r_\text{inner})
-   *     \frac{1 - \tanh(\text{skewness}(1 - k/\text{n_shells}))}
+   *     \frac{1 - \tanh(\text{skewness}(1 - k/\text{n\_shells}))}
    *          {\tanh(\text{skewness})}
    * @f]
    *
index 5dfd3827f967a34ca1797a01be02104bc81b1ee7..d9ac04ba2bd056bdf9a64ee8a72f4f461033ed27 100644 (file)
@@ -472,10 +472,10 @@ private:
  *
  * This is based on the definition of elliptic coordinates $(u,v)$
  * @f[
- *  \left\lbrace\begin{align*}
+ *  \left\lbrace\begin{aligned}
  *  x &=  x_0 + c \cosh(u) \cos(v) \\
  *  y &=  y_0 + c \sinh(u) \sin(v)
- *  \end{align*}\right.
+ *  \end{aligned}\right.
  * @f]
  * in which $(x_0,y_0)$ are coordinates of the center of the cartesian system.
  *
index 68a87246a485bf08d210e334cc762c470d9497f7..b970312493ddc5095b035f17c851def9eb71b099 100644 (file)
@@ -32,7 +32,7 @@ DEAL_II_NAMESPACE_OPEN
  *
  * This class and classes derived from it are meant to build $Q$ and $R$
  * matrices one row/column at a time, i.e., by growing $R$ matrix from an empty
- * $0\times0$ matrix to $N\timesN$, where $N$ is the number of added column
+ * $0\times 0$ matrix to $N\times N$, where $N$ is the number of added column
  * vectors.
  *
  * As a consequence, matrices which have the same number of rows as each vector
index 6caa393e19fbcbb59db76815e156c3c8567bd853..5d4ebe19f061c31e2984264393c8040b775e2cdd 100644 (file)
@@ -33,7 +33,7 @@ DEAL_II_NAMESPACE_OPEN
  * method for function minimization in which the Hessian matrix is only
  * approximated. In particular, the Hessian is updated using the formula of
  * Broyden, Fletcher, Goldfarb, and Shanno (BFGS):
- * \f[
+ * @f{align*}{
  * H^{(k+1)} &= \left[
  * I-\rho_{(k)} s^{(k)} \otimes y^{(k)}
  * \right]
@@ -46,7 +46,7 @@ DEAL_II_NAMESPACE_OPEN
  * y^{(k)} &\dealcoloneq g^{(k+1)} - g^{(k)} \\
  * s^{(k)} &\dealcoloneq x^{(k+1)} - x^{(k)} \\
  * \rho^{(k)} &\dealcoloneq \frac{1}{y^{(k)} \cdot s^{(k)}}
- * \f]
+ * @f}
  * for a symmetric positive definite $H$. Limited memory variant is
  * implemented via the two-loop recursion.
  *

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.