]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Fix doxygen underscores. 10253/head
authorDavid Wells <drwells@email.unc.edu>
Thu, 28 May 2020 02:50:58 +0000 (22:50 -0400)
committerDavid Wells <drwells@email.unc.edu>
Thu, 28 May 2020 02:50:58 +0000 (22:50 -0400)
We need to use $\mathtt{A\_B}$ and not $\texttt{A\_B}$ to correctly print an
underscore and not the backslash.

include/deal.II/base/derivative_form.h
include/deal.II/base/index_set.h
include/deal.II/base/tensor_accessors.h
include/deal.II/grid/grid_generator.h
include/deal.II/lac/slepc_solver.h
include/deal.II/physics/elasticity/standard_tensors.h

index 237c46aaa692c99d84780bf4b9531f7ca83e1627..b76971f70ecca41f679bcffaf0f653307fb1f012 100644 (file)
@@ -410,7 +410,8 @@ apply_transformation(const DerivativeForm<1, dim, spacedim, Number> &grad_F,
 /**
  * Similar to the previous apply_transformation().
  * Each row of the result corresponds to one of the rows of @p D_X transformed
- * by @p grad_F, equivalent to $\text{D\_X} \, \text{grad\_F}^T$ in matrix notation.
+ * by @p grad_F, equivalent to $\mathrm{D\_X} \, \mathrm{grad\_F}^T$ in matrix
+ * notation.
  *
  * @relatesalso DerivativeForm
  * @author Sebastian Pauletti, 2011, Reza Rastak, 2019
index d088b4f3bce0345d5ef8ca252102758e89ece22c..2a5856e1b0f644f6cf8092cd98e242a80f40cba3 100644 (file)
@@ -50,7 +50,7 @@ DEAL_II_NAMESPACE_OPEN
 /**
  * A class that represents a subset of indices among a larger set. For
  * example, it can be used to denote the set of degrees of freedom within the
- * range $[0,\text{dof\_handler.n\_dofs})$ that belongs to a particular
+ * range $[0,\mathrm{dof\_handler.n\_dofs()})$ that belongs to a particular
  * subdomain, or those among all degrees of freedom that are stored on a
  * particular processor in a distributed parallel computation.
  *
index 101a702587b26670d3859bc14ec824a480bae943..581792cd9eae275f675134e950bdd742002b799a 100644 (file)
@@ -237,9 +237,9 @@ namespace TensorAccessors
    *
    * @f[
    *   \text{result}_{i_1,..,i_{r1},j_1,..,j_{r2}}
-   *   = \sum_{k_1,..,k_{\text{no\_contr}}}
-   *     \text{left}_{i_1,..,i_{r1},k_1,..,k_{\text{no\_contr}}}
-   *     \text{right}_{j_1,..,j_{r2},k_1,..,k_{\text{no\_contr}}}
+   *   = \sum_{k_1,..,k_{\mathrm{no\_contr}}}
+   *     \mathrm{left}_{i_1,..,i_{r1},k_1,..,k_{\mathrm{no\_contr}}}
+   *     \mathrm{right}_{j_1,..,j_{r2},k_1,..,k_{\mathrm{no\_contr}}}
    * @f]
    *
    * Calling this function is equivalent of writing the following low level
index c2c3498c43ae7db94b9b5977a620428488d3a578..9bf6ac1b64de829abb6c1689387572eaf054a9f1 100644 (file)
@@ -1398,9 +1398,9 @@ namespace GridGenerator
    * radius of the $k$th shell is given by
    *
    * @f[
-   *     r = r_{\text{inner}} + (r_\text{outer} - r_\text{inner})
-   *     \frac{1 - \tanh(\text{skewness}(1 - k/\text{n\_shells}))}
-   *          {\tanh(\text{skewness})}
+   *     r = r_{\mathrm{inner}} + (r_\mathrm{outer} - r_\mathrm{inner})
+   *     \frac{1 - \tanh(\mathrm{skewness}(1 - k/\mathrm{n\_shells}))}
+   *          {\tanh(\mathrm{skewness})}
    * @f]
    *
    * where @p skewness is a parameter controlling the shell spacing in the
index 29229245dfe8116d5539b486f13f6d9059e14d90..0eff308765466571af1799df9db9dc87470358b5 100644 (file)
@@ -313,7 +313,7 @@ namespace SLEPcWrappers
     /**
      * Access the real parts of solutions for a solved eigenvector problem,
      * pair index solutions, $\text{index}\,\in\,0\dots
-     * \text{n\_converged}-1$.
+     * \mathrm{n\_converged}-1$.
      */
     void
     get_eigenpair(const unsigned int         index,
@@ -323,7 +323,7 @@ namespace SLEPcWrappers
     /**
      * Access the real and imaginary parts of solutions for a solved
      * eigenvector problem, pair index solutions, $\text{index}\,\in\,0\dots
-     * \text{n\_converged}-1$.
+     * \mathrm{n\_converged}-1$.
      */
     void
     get_eigenpair(const unsigned int         index,
index d24820e985f70f49365c9bccbea6ea5e9797dc59..f18ce195effd087935c6893ef7cd2b085545741c 100644 (file)
@@ -153,12 +153,12 @@ namespace Physics
        *  \dealcoloneq \{ \bullet \} - \frac{1}{\textrm{dim}}
        *  \left[ \{ \bullet \} : \mathbf{I} \right]\mathbf{I}
        *  = \mathcal{P}^{T} : \{ \bullet \}
-       *  = \texttt{dev\_P} \left( \{ \bullet \} \right)
+       *  = \mathtt{dev\_P} \left( \{ \bullet \} \right)
        * @f]
        * and, therefore,
        * @f[
-       * \texttt{dev\_P} \left( \{ \bullet \} \right) : \mathbf{I}
-       *   = \textrm{trace}(\texttt{dev\_P} \left( \{ \bullet \} \right)) = 0 \,
+       * \mathtt{dev\_P} \left( \{ \bullet \} \right) : \mathbf{I}
+       *   = \mathrm{trace}(\mathtt{dev\_P} \left( \{ \bullet \} \right)) = 0 \,
        * .
        * @f]
        *
@@ -201,12 +201,12 @@ namespace Physics
        *  \{ \bullet \} : \hat{\mathcal{P}}
        *    \dealcoloneq J^{-2/\textrm{dim}} \left[ \{ \bullet \} -
        * \frac{1}{\textrm{dim}}\left[\mathbf{C} : \{ \bullet \}\right]
-       * \mathbf{C}^{-1} \right] = \texttt{Dev\_P} \left( \{ \bullet \} \right)
+       * \mathbf{C}^{-1} \right] = \mathtt{Dev\_P} \left( \{ \bullet \} \right)
        * \, .
        * @f]
        * It can therefore be readily shown that
        * @f[
-       *  \texttt{Dev\_P} \left( \{ \bullet \} \right) : \mathbf{C} = 0 \, .
+       *  \mathtt{Dev\_P} \left( \{ \bullet \} \right) : \mathbf{C} = 0 \, .
        * @f]
        *
        * @note It may be observed that we have defined the tensor as the
@@ -244,7 +244,7 @@ namespace Physics
        *  \hat{\mathcal{P}}^{T} : \{ \bullet \}
        *    = J^{-2/\textrm{dim}} \left[ \{ \bullet \} - \frac{1}{\textrm{dim}}
        * \left[\mathbf{C}^{-1} : \{ \bullet \}\right] \mathbf{C} \right] =
-       * \texttt{Dev\_P\_T} \{ \bullet \}
+       * \mathtt{Dev\_P\_T} \{ \bullet \}
        * @f]
        */
       template <typename Number>

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.